Guide d’utilisation de
© 2020 Is Daouda Games
2
Contenu
Guide de démarrage ......................................................................................................................................................................................... 17
1. Introduction ............................................................................................................................................................................................ 17
2. A propos du moteur ............................................................................................................................................................................... 17
3. Structure du moteur ............................................................................................................................................................................... 17
3.1 app_src................................................................................................................................................................................................ 17
3.2 isEngine .............................................................................................................................................................................................. 18
3.3 data ..................................................................................................................................................................................................... 18
3.4 Fichier main.cpp ................................................................................................................................................................................ 18
3.4.1 main ............................................................................................................................................................................................... 18
3.4.2 game.play ...................................................................................................................................................................................... 18
3.4.3 game.basicSFMLmain ................................................................................................................................................................... 18
Display .............................................................................................................................................................................................................. 18
1. class GameDisplay .................................................................................................................................................................................. 18
2. Les méthodes publiques ........................................................................................................................................................................ 19
2.1 GameDisplay ...................................................................................................................................................................................... 19
2.2 setAdmob ........................................................................................................................................................................................... 19
2.3 rewardVideoStep ............................................................................................................................................................................... 19
2.4 step ..................................................................................................................................................................................................... 19
2.5 draw .................................................................................................................................................................................................... 19
2.6 drawScreen ........................................................................................................................................................................................ 19
2.7 showTempLoading ............................................................................................................................................................................ 20
2.8 setOptionIndex .................................................................................................................................................................................. 20
2.9 setTextAnimation .............................................................................................................................................................................. 20
2.10 setView .......................................................................................................................................................................................... 20
2.11 loadParentResources .................................................................................................................................................................... 20
2.12 loadResources ............................................................................................................................................................................... 21
2.13 setIsRunning ................................................................................................................................................................................. 21
2.14 setIsPlaying ................................................................................................................................................................................... 21
2.15 setSceneStart ................................................................................................................................................................................. 21
2.16 setSceneEnd .................................................................................................................................................................................. 21
2.17 setKeyBackPressed ....................................................................................................................................................................... 21
2.18 isRunning ...................................................................................................................................................................................... 21
2.19 getIsPlaying ................................................................................................................................................................................... 21
2.20 getSceneStart ................................................................................................................................................................................ 22
2.21 getSceneEnd .................................................................................................................................................................................. 22
2.22 getWindowIsActive....................................................................................................................................................................... 22
2.23 getKeyBackPressed ...................................................................................................................................................................... 22
2.24 getView .......................................................................................................................................................................................... 22
2.25 getRenderWindow ........................................................................................................................................................................ 22
2.26 getRenderTexture ......................................................................................................................................................................... 22
2.27 getGameSystem ............................................................................................................................................................................. 22
3
2.28 getFontSystem .............................................................................................................................................................................. 23
2.29 getFontMsg .................................................................................................................................................................................... 23
2.30 getSprButtonSelect ....................................................................................................................................................................... 23
2.31 getOptionIndex ............................................................................................................................................................................. 23
2.32 getSceneWidth .............................................................................................................................................................................. 23
2.33 getSceneHeight ............................................................................................................................................................................. 23
2.34 getDeltaTime ................................................................................................................................................................................. 23
2.35 getDELTA_TIME ............................................................................................................................................................................ 23
2.36 getSprButtonSelectScale .............................................................................................................................................................. 24
2.37 getViewX ........................................................................................................................................................................................ 24
2.38 getViewY ........................................................................................................................................................................................ 24
2.39 getViewW ...................................................................................................................................................................................... 24
2.40 getViewH ....................................................................................................................................................................................... 24
2.41 getBgColor ..................................................................................................................................................................................... 24
2.42 inViewRec ...................................................................................................................................................................................... 24
2.43 mouseCollision .............................................................................................................................................................................. 24
2.44 SDMmanageScene ......................................................................................................................................................................... 26
2.45 SDMmanageSceneEvents ............................................................................................................................................................. 26
2.46 SDMmanageSceneMsgAnswers ................................................................................................................................................... 26
2.47 SDMstep ......................................................................................................................................................................................... 26
2.48 SDMdraw ....................................................................................................................................................................................... 26
2.49 GSMplaySound .............................................................................................................................................................................. 26
2.50 GSMpauseSound ........................................................................................................................................................................... 26
2.51 GSMplayMusic ............................................................................................................................................................................... 27
2.52 GSMpauseMusic ............................................................................................................................................................................ 27
3. Éléments protégés .................................................................................................................................................................................. 27
3.1 enum MsgAnswer .............................................................................................................................................................................. 27
3.2 controlEventFocusClosing ................................................................................................................................................................ 27
3.3 showMessageBox ............................................................................................................................................................................... 27
3.4 updateMsgBox ................................................................................................................................................................................... 27
3.5 updateTimeWait ................................................................................................................................................................................ 28
3.6 drawMsgBox ...................................................................................................................................................................................... 28
SDM (Step and Draw Manager) ......................................................................................................................................................................... 28
1. class SDM ................................................................................................................................................................................................ 28
2. Les éléments publics de SDM ................................................................................................................................................................. 28
2.1 m_SDMsceneObjects .......................................................................................................................................................................... 28
2.2 SDMgetObject ..................................................................................................................................................................................... 28
2.3 SDMaddSceneObject .......................................................................................................................................................................... 28
2.4 SDMaddSprite .................................................................................................................................................................................... 29
2.5 SDMsetObjDepth ................................................................................................................................................................................ 29
Game Sound ...................................................................................................................................................................................................... 29
1. class GameSound .................................................................................................................................................................................... 29
4
2. Les éléments publics de GameSound .................................................................................................................................................... 29
2.1 GameSound ........................................................................................................................................................................................ 29
2.2 loadResources .................................................................................................................................................................................... 29
2.3 getSoundBuffer .................................................................................................................................................................................. 30
2.4 getSound............................................................................................................................................................................................. 30
Game Music ....................................................................................................................................................................................................... 30
1. class GameMusic ..................................................................................................................................................................................... 30
2. Les éléments publics de GameMusic ..................................................................................................................................................... 30
2.1 GameMusic ......................................................................................................................................................................................... 30
2.2 loadResources .................................................................................................................................................................................... 30
2.3 getMusic ............................................................................................................................................................................................. 30
GSM (Game Sound System) ............................................................................................................................................................................. 30
1. class GSM ................................................................................................................................................................................................. 31
2. Les éléments publics de GSM ................................................................................................................................................................. 31
2.1 Les Conteneurs du GSM ..................................................................................................................................................................... 31
2.2 GSMaddSound .................................................................................................................................................................................... 31
2.3 GSMaddMusic..................................................................................................................................................................................... 31
2.4 GSMgetSound ..................................................................................................................................................................................... 31
2.5 GSMgetMusic ...................................................................................................................................................................................... 31
Entités ............................................................................................................................................................................................................... 32
1. class MainObject ..................................................................................................................................................................................... 32
2. Les éléments publics de MainObjet ....................................................................................................................................................... 32
2.1 MainObject ......................................................................................................................................................................................... 32
2.2 instanceNumber ................................................................................................................................................................................ 32
2.3 m_SDMcallStep ................................................................................................................................................................................... 32
2.4 m_SDMcallDraw ................................................................................................................................................................................. 32
2.5 setXStart ............................................................................................................................................................................................. 33
2.6 setYStart ............................................................................................................................................................................................. 33
2.7 setXPrevious ...................................................................................................................................................................................... 33
2.8 setYPrevious ...................................................................................................................................................................................... 33
2.9 setStartPosition ................................................................................................................................................................................. 33
2.10 setX ................................................................................................................................................................................................ 33
2.11 setY ................................................................................................................................................................................................ 33
2.12 moveX ............................................................................................................................................................................................ 33
2.13 moveY ............................................................................................................................................................................................ 34
2.14 setPosition ..................................................................................................................................................................................... 34
2.15 setSpriteScale ................................................................................................................................................................................ 34
2.16 setSpeed ........................................................................................................................................................................................ 34
2.17 setHsp ............................................................................................................................................................................................ 34
2.18 setVsp ............................................................................................................................................................................................ 34
2.19 setAngularMove ............................................................................................................................................................................ 34
2.20 setImageXscale .............................................................................................................................................................................. 34
5
2.21 setImageYscale .............................................................................................................................................................................. 35
2.22 setImageScale ................................................................................................................................................................................ 35
2.23 setImageAngle ............................................................................................................................................................................... 35
2.24 setXOffset ...................................................................................................................................................................................... 35
2.25 setYOffset ...................................................................................................................................................................................... 35
2.26 setXYOffset .................................................................................................................................................................................... 35
2.27 setTime .......................................................................................................................................................................................... 35
2.28 setImageAlpha .............................................................................................................................................................................. 35
2.29 setImageIndex ............................................................................................................................................................................... 36
2.30 setMaskW ...................................................................................................................................................................................... 36
2.31 setMaskH ....................................................................................................................................................................................... 36
2.32 setIsActive ..................................................................................................................................................................................... 36
2.33 updateCollisionMask .................................................................................................................................................................... 36
2.34 centerCollisionMask ..................................................................................................................................................................... 36
2.35 updateSprite .................................................................................................................................................................................. 37
2.36 draw ............................................................................................................................................................................................... 37
2.37 drawMask ...................................................................................................................................................................................... 37
2.38 getMask ......................................................................................................................................................................................... 37
2.39 getCircleMask ................................................................................................................................................................................ 37
2.40 getX ................................................................................................................................................................................................ 37
2.41 getY ................................................................................................................................................................................................ 37
2.42 getXStart ........................................................................................................................................................................................ 38
2.43 getYStart ........................................................................................................................................................................................ 38
2.44 getXPrevious ................................................................................................................................................................................. 38
2.45 getYPrevious ................................................................................................................................................................................. 38
2.46 distantToPoint .............................................................................................................................................................................. 38
2.47 distantToObject............................................................................................................................................................................. 38
2.48 pointDirection ............................................................................................................................................................................... 38
2.49 pointDirectionSprite ..................................................................................................................................................................... 39
2.50 getSpeed ........................................................................................................................................................................................ 39
2.51 getHsp ............................................................................................................................................................................................ 39
2.52 getVsp ............................................................................................................................................................................................ 39
2.53 getFrame ....................................................................................................................................................................................... 39
2.54 getFrameStart ............................................................................................................................................................................... 39
2.55 getFrameEnd ................................................................................................................................................................................. 40
2.56 getImageXscale ............................................................................................................................................................................. 40
2.57 getImageYscale ............................................................................................................................................................................. 40
2.58 getImageScale ............................................................................................................................................................................... 40
2.59 getImageAngle .............................................................................................................................................................................. 40
2.60 getXOffset ...................................................................................................................................................................................... 40
2.61 getYOffset ...................................................................................................................................................................................... 40
2.62 getTime .......................................................................................................................................................................................... 40
6
2.63 getInstanceId................................................................................................................................................................................. 41
2.64 getMaskW ...................................................................................................................................................................................... 41
2.65 getMaskH ....................................................................................................................................................................................... 41
2.66 getIsActive ..................................................................................................................................................................................... 41
2.67 getImageAlpha .............................................................................................................................................................................. 41
2.68 getImageIndex .............................................................................................................................................................................. 41
2.69 getSpriteWidth .............................................................................................................................................................................. 41
2.70 getSpriteHeight ............................................................................................................................................................................. 41
2.71 getSpriteX ...................................................................................................................................................................................... 42
2.72 getSpriteY ...................................................................................................................................................................................... 42
2.73 getSpriteCenterX ........................................................................................................................................................................... 42
2.74 getSpriteCenterY ........................................................................................................................................................................... 42
2.75 placeMetting .................................................................................................................................................................................. 42
2.76 getSprite ........................................................................................................................................................................................ 42
2.77 setFrame ........................................................................................................................................................................................ 42
3. Autres fonctions de MainObject ............................................................................................................................................................ 43
3.1 instanceExist ...................................................................................................................................................................................... 43
3.2 operator()........................................................................................................................................................................................... 43
3.3 sortObjArrayByX................................................................................................................................................................................ 43
3.4 sortObjArrayByDepth........................................................................................................................................................................ 44
3.5 operator> ........................................................................................................................................................................................... 44
3.6 operator< ........................................................................................................................................................................................... 44
Les formes pour les masques collisions ............................................................................................................................................................. 44
1. class Rectangle ........................................................................................................................................................................................ 44
2. class Circle............................................................................................................................................................................................... 44
Les Classes Parentes de MainObject .................................................................................................................................................................. 44
1. class DepthObject ................................................................................................................................................................................... 45
1.1 enum Depth ........................................................................................................................................................................................ 45
1.2 DepthObject ....................................................................................................................................................................................... 45
1.3 setDepth ............................................................................................................................................................................................. 45
1.4 getDepth ............................................................................................................................................................................................. 45
2. class Destructible ................................................................................................................................................................................... 45
2.1 Destructible ........................................................................................................................................................................................ 45
2.2 setDestroyed ...................................................................................................................................................................................... 46
2.3 isDestroyed ........................................................................................................................................................................................ 46
3. class Visibility ......................................................................................................................................................................................... 46
3.1 Visibility ............................................................................................................................................................................................. 46
3.2 setVisible ............................................................................................................................................................................................ 46
3.3 getVisible ............................................................................................................................................................................................ 46
4. class Health ............................................................................................................................................................................................. 46
4.1 Health ................................................................................................................................................................................................. 47
4.2 setHealth ............................................................................................................................................................................................ 47
7
4.3 setMaxHealth ..................................................................................................................................................................................... 47
4.4 addHealth ........................................................................................................................................................................................... 47
4.5 getHealth ............................................................................................................................................................................................ 47
4.6 getMaxHealth ..................................................................................................................................................................................... 47
5. class HurtEffect ....................................................................................................................................................................................... 47
5.1 HurtEffect ........................................................................................................................................................................................... 48
5.2 hurtStep .............................................................................................................................................................................................. 48
5.3 setIsHurt ............................................................................................................................................................................................. 48
5.4 getIsHurt ............................................................................................................................................................................................ 48
6. class ScorePoint ...................................................................................................................................................................................... 48
6.1 ScorePoint .......................................................................................................................................................................................... 48
6.2 setScorePoint ..................................................................................................................................................................................... 48
6.3 getScorePoint ..................................................................................................................................................................................... 49
7. class Step ................................................................................................................................................................................................. 49
7.1 Step ..................................................................................................................................................................................................... 49
7.2 setStep ................................................................................................................................................................................................ 49
7.3 addStep ............................................................................................................................................................................................... 49
7.4 reduceStep ......................................................................................................................................................................................... 49
7.5 getStep ................................................................................................................................................................................................ 49
8. class Name .............................................................................................................................................................................................. 49
8.1 Name................................................................................................................................................................................................... 50
8.2 setName .............................................................................................................................................................................................. 50
8.3 getName ............................................................................................................................................................................................. 50
9. class FilePath .......................................................................................................................................................................................... 50
9.1 FilePath .............................................................................................................................................................................................. 50
9.2 setFilePath.......................................................................................................................................................................................... 50
9.3 getFilePath ......................................................................................................................................................................................... 50
9.4 getFileIsLoaded.................................................................................................................................................................................. 50
Le Backgroud ..................................................................................................................................................................................................... 51
1. class Background .................................................................................................................................................................................... 51
2. Les méthodes publiques ........................................................................................................................................................................ 51
2.1 Background ........................................................................................................................................................................................ 51
2.2 step ..................................................................................................................................................................................................... 51
Admob ............................................................................................................................................................................................................... 51
1. class AdmobManager ............................................................................................................................................................................. 51
2. Les méthodes publiques ........................................................................................................................................................................ 51
2.1 AdmobManager ................................................................................................................................................................................. 51
2.2 loadBannerAd .................................................................................................................................................................................... 52
2.3 showBannerAd .................................................................................................................................................................................. 52
2.4 hideBannerAd .................................................................................................................................................................................... 52
2.5 loadRewardVideo .............................................................................................................................................................................. 52
2.6 updateSFMLApp ................................................................................................................................................................................ 52
8
2.7 checkAdObjInit .................................................................................................................................................................................. 52
2.8 checkAdRewardObjReinitialize ........................................................................................................................................................ 52
3. Autres Fonction d’AdmobManager ....................................................................................................................................................... 52
3.1 ProcessEvents & WaitForFutureCompletion ................................................................................................................................... 52
3.2 checkAdState ...................................................................................................................................................................................... 53
Temps ............................................................................................................................................................................................................... 53
1. class GameTime ...................................................................................................................................................................................... 53
2. Les methods publiques de GameTime .................................................................................................................................................. 53
2.1 GameTime .......................................................................................................................................................................................... 53
2.2 step ..................................................................................................................................................................................................... 53
2.3 addTimeValue .................................................................................................................................................................................... 54
2.4 setTimeValue ..................................................................................................................................................................................... 54
2.5 setMSecond ........................................................................................................................................................................................ 54
2.6 getTimeString .................................................................................................................................................................................... 54
2.7 getTimeValue ..................................................................................................................................................................................... 54
2.8 getMinute ........................................................................................................................................................................................... 54
2.9 getSecond ........................................................................................................................................................................................... 54
2.10 getMSecond ................................................................................................................................................................................... 54
2.11 compareTime ................................................................................................................................................................................ 55
2.12 operator=....................................................................................................................................................................................... 55
2.13 operator<< .................................................................................................................................................................................... 55
3. Autres Fonctions de GameTime ............................................................................................................................................................ 55
Commande du jeu ............................................................................................................................................................................................ 55
1. class GameKeyData ................................................................................................................................................................................ 55
2. Les éléments de GameKeyData .............................................................................................................................................................. 55
2.1 enum VirtualKeyIndex ...................................................................................................................................................................... 55
2.2 GameKeyData ..................................................................................................................................................................................... 56
2.3 loadResources .................................................................................................................................................................................... 56
2.4 step ..................................................................................................................................................................................................... 56
2.5 draw .................................................................................................................................................................................................... 56
2.6 m_keyPausePressed .......................................................................................................................................................................... 56
2.7 m_keyLeftPressed .............................................................................................................................................................................. 56
2.8 m_keyRightPressed ........................................................................................................................................................................... 56
2.9 m_keyUpPressed ................................................................................................................................................................................ 57
2.10 m_keyDownPressed...................................................................................................................................................................... 57
2.11 m_keyAPressed ............................................................................................................................................................................. 57
2.12 m_keyBPressed ............................................................................................................................................................................. 57
2.13 m_keyAUsed .................................................................................................................................................................................. 57
2.14 m_keyBUsed .................................................................................................................................................................................. 57
2.15 m_keyLeftUsed .............................................................................................................................................................................. 57
2.16 m_keyRightUsed ........................................................................................................................................................................... 57
2.17 m_keyUpUsed ................................................................................................................................................................................ 58
9
2.18 m_keyDownUsed .......................................................................................................................................................................... 58
2.19 m_disableAllKey ............................................................................................................................................................................ 58
2.20 m_hideGamePad ........................................................................................................................................................................... 58
2.21 m_keyboardA ................................................................................................................................................................................ 58
2.22 m_keyboardB ................................................................................................................................................................................ 58
2.23 m_keyboardLeft ............................................................................................................................................................................ 58
2.24 m_keyboardRight .......................................................................................................................................................................... 58
2.25 m_keyboardUp .............................................................................................................................................................................. 59
2.26 m_keyboardDown ......................................................................................................................................................................... 59
2.27 m_moveKeyPressed ...................................................................................................................................................................... 59
2.28 m_actionKeyPressed ..................................................................................................................................................................... 59
2.29 keyLeftPressed .............................................................................................................................................................................. 59
2.30 keyRightPressed ........................................................................................................................................................................... 59
2.31 keyUpPressed ............................................................................................................................................................................... 59
2.32 keyDownPressed .......................................................................................................................................................................... 59
2.33 keyAPressed .................................................................................................................................................................................. 60
2.34 keyBPressed .................................................................................................................................................................................. 60
2.35 virtualKeyPressed ......................................................................................................................................................................... 60
3. Autres fonctions de GameKeyData ........................................................................................................................................................ 60
Game Système .................................................................................................................................................................................................. 60
1. class GameSystem .................................................................................................................................................................................. 60
2. Les éléments de GameSystem ................................................................................................................................................................ 61
2.1 enum ValidationButton ..................................................................................................................................................................... 61
2.2 GameSystem ....................................................................................................................................................................................... 61
2.3 isPressed ............................................................................................................................................................................................ 61
2.4 keyIsPressed ...................................................................................................................................................................................... 62
2.5 fileExist ............................................................................................................................................................................................... 62
2.6 playSound ........................................................................................................................................................................................... 62
2.7 playMusic ........................................................................................................................................................................................... 62
2.8 stopSound .......................................................................................................................................................................................... 62
2.9 stopMusic ........................................................................................................................................................................................... 63
2.10 useVibrate ..................................................................................................................................................................................... 63
2.11 saveConfig ..................................................................................................................................................................................... 63
2.12 loadConfig ..................................................................................................................................................................................... 63
2.13 savePadConfig ............................................................................................................................................................................... 63
2.14 loadPadConfig ............................................................................................................................................................................... 63
2.15 m_disableKey ................................................................................................................................................................................ 63
2.16 m_enableSound ............................................................................................................................................................................. 63
2.17 m_enableMusic .............................................................................................................................................................................. 64
2.18 m_enableVibrate ........................................................................................................................................................................... 64
2.19 m_keyIsPressed............................................................................................................................................................................. 64
2.20 m_firstLaunch ............................................................................................................................................................................... 64
10
2.21 m_validationMouseKey ................................................................................................................................................................ 64
2.22 m_validationKeyboardKey ........................................................................................................................................................... 64
2.23 m_gameLanguage.......................................................................................................................................................................... 64
2.24 m_padAlpha ................................................................................................................................................................................... 64
Game System Extended ..................................................................................................................................................................................... 65
1. class GameSystemExtended................................................................................................................................................................... 65
2. Les éléments de GameSystemExtended ................................................................................................................................................ 65
2.1 GameSystemExtended ....................................................................................................................................................................... 65
2.2 initSystemData ................................................................................................................................................................................... 65
2.3 initProgress ........................................................................................................................................................................................ 65
2.4 initData ............................................................................................................................................................................................... 65
2.5 saveData ............................................................................................................................................................................................. 65
2.6 loadData ............................................................................................................................................................................................. 66
2.7 m_launchOption ................................................................................................................................................................................. 66
2.8 game play variables ........................................................................................................................................................................... 66
Game Function ................................................................................................................................................................................................. 66
1. Fonction Générale .................................................................................................................................................................................. 66
1.1 VALUE_CONVERSION ........................................................................................................................................................................ 66
1.2 WITH .................................................................................................................................................................................................. 66
1.3 w_chart_tToStr ................................................................................................................................................................................... 67
1.4 strToWStr ........................................................................................................................................................................................... 67
1.5 numToStr ........................................................................................................................................................................................... 67
1.6 strToNum ........................................................................................................................................................................................... 67
1.7 numToWStr ........................................................................................................................................................................................ 67
1.8 writeZero............................................................................................................................................................................................ 67
1.9 getMSecond ........................................................................................................................................................................................ 68
1.10 showLog ........................................................................................................................................................................................ 68
1.11 arraySize ........................................................................................................................................................................................ 68
1.12 choose ............................................................................................................................................................................................ 68
1.13 setVarLimit .................................................................................................................................................................................... 68
1.14 isIn ................................................................................................................................................................................................. 69
1.15 isBetween ...................................................................................................................................................................................... 69
1.16 isCrossing ...................................................................................................................................................................................... 69
1.17 side ................................................................................................................................................................................................. 69
1.18 sign ................................................................................................................................................................................................. 69
1.19 pointDirection ............................................................................................................................................................................... 69
1.20 pointDistance ................................................................................................................................................................................ 70
1.21 radToDeg ....................................................................................................................................................................................... 70
1.22 degToRad ...................................................................................................................................................................................... 70
1.23 lengthDirX ..................................................................................................................................................................................... 70
1.24 lengthDirY ..................................................................................................................................................................................... 70
1.25 increaseVar ................................................................................................................................................................................... 70
11
1.26 decreaseVar ................................................................................................................................................................................... 70
1.27 collisionTest .................................................................................................................................................................................. 71
2. Fonction sur les objets SFML ................................................................................................................................................................. 71
2.1 getSFMLObjAngle .............................................................................................................................................................................. 71
2.2 getSFMLObjXScale ............................................................................................................................................................................. 71
2.3 getSFMLObjYScale ............................................................................................................................................................................. 71
2.4 getSFMLObjWidth.............................................................................................................................................................................. 71
2.5 getSFMLObjHeight ............................................................................................................................................................................. 72
2.6 getSFMLObjOriginX ........................................................................................................................................................................... 72
2.7 getSFMLObjOriginY ........................................................................................................................................................................... 72
2.8 getSFMLObjX ...................................................................................................................................................................................... 72
2.9 getSFMLObjY ...................................................................................................................................................................................... 72
2.10 setSFMLObjAngle .......................................................................................................................................................................... 73
2.11 setSFMLObjRotate ........................................................................................................................................................................ 73
2.12 setSFMLObjScaleX_Y .......................................................................................................................................................................... 73
2.13 setSFMLObjScale ........................................................................................................................................................................... 73
2.14 setSFMLObjOrigin ......................................................................................................................................................................... 73
2.15 setSFMLObjX ................................................................................................................................................................................. 73
2.16 setSFMLObjY ................................................................................................................................................................................. 74
2.17 centerSFMLObj .............................................................................................................................................................................. 74
2.18 centerSFMLObjX ........................................................................................................................................................................... 74
2.19 centerSFMLObjY ........................................................................................................................................................................... 74
2.20 setSFMLObjX_Y ............................................................................................................................................................................. 74
2.21 moveSFMLObjX ............................................................................................................................................................................. 74
2.22 moveSFMLObjY ............................................................................................................................................................................. 75
2.23 setSFMLObjSize ............................................................................................................................................................................. 75
2.24 setSFMLObjAlpha.......................................................................................................................................................................... 75
2.25 setSFMLObjAlpha2 ....................................................................................................................................................................... 75
2.26 setSFMLObjColor .......................................................................................................................................................................... 76
2.27 setSFMLObjFillColor ..................................................................................................................................................................... 76
2.28 scaleAnimation ............................................................................................................................................................................. 76
2.29 setFrame ........................................................................................................................................................................................ 76
2.30 setSFMLObjOutlineColor .............................................................................................................................................................. 76
2.31 setSFMLObjTexRec ....................................................................................................................................................................... 76
2.32 setSFMLObjProperties .................................................................................................................................................................. 77
2.33 loadSFMLObjResource ................................................................................................................................................................. 77
2.34 getSFMLSndState .......................................................................................................................................................................... 77
2.35 collisionTestSFML ......................................................................................................................................................................... 77
2.36 createRectangle............................................................................................................................................................................. 78
2.37 textStyleConfig .............................................................................................................................................................................. 78
2.38 createWText .................................................................................................................................................................................. 78
2.39 createText...................................................................................................................................................................................... 78
12
2.40 createSprite ................................................................................................................................................................................... 79
2.41 mouseCollision .............................................................................................................................................................................. 79
3. Autres fonctions ..................................................................................................................................................................................... 80
3.1 vibrate ................................................................................................................................................................................................ 80
3.2 openURL ............................................................................................................................................................................................. 80
3.3 setScreenLock .................................................................................................................................................................................... 80
3.4 jstring2string ..................................................................................................................................................................................... 80
3.5 getDeviceId ........................................................................................................................................................................................ 81
Bibliothèque externe ....................................................................................................................................................................................... 81
1. Swoosh .................................................................................................................................................................................................... 81
2. Tiny File Dialogs (uniquement pour Windows et Linux) .................................................................................................................... 81
2.1 class TinyDialogBox ........................................................................................................................................................................... 81
2.2 tinyString ............................................................................................................................................................................................ 81
2.3 TINY_FILE_DIALOGBOX_PATH ......................................................................................................................................................... 81
2.4 enum FileDialogType ........................................................................................................................................................................ 82
2.5 enum DialogType ............................................................................................................................................................................... 82
2.6 enum IconType .................................................................................................................................................................................. 82
2.7 enumDialogTypeToStr / enumIconTypeToStr ................................................................................................................................ 82
2.8 showDialogBox .................................................................................................................................................................................. 82
2.9 showFileDialogBox ............................................................................................................................................................................ 83
2.10 showFolderDialogBox .................................................................................................................................................................. 83
3. Box 2D ..................................................................................................................................................................................................... 83
Game Engine ..................................................................................................................................................................................................... 84
1. class GameEngine ................................................................................................................................................................................... 84
2. Les méthodes de GameEngine ............................................................................................................................................................... 84
2.1 GameEngine ....................................................................................................................................................................................... 84
2.2 initEngine ........................................................................................................................................................................................... 84
2.3 play ..................................................................................................................................................................................................... 84
2.4 basicSFMLmain .................................................................................................................................................................................. 84
2.5 getRenderWindow............................................................................................................................................................................. 84
Configuration du jeu ........................................................................................................................................................................................ 85
1. enum DisplayOption ............................................................................................................................................................................... 85
2. Paramètre de la fenêtre.......................................................................................................................................................................... 85
2.1 WINDOW_WIDTH .............................................................................................................................................................................. 85
2.2 WINDOW_HEIGHT ............................................................................................................................................................................. 85
2.3 VIEW_WIDTH ..................................................................................................................................................................................... 85
2.4 VIEW_HEIGHT .................................................................................................................................................................................... 85
2.5 FPS ...................................................................................................................................................................................................... 86
2.6 WINDOW_SETTINGS ......................................................................................................................................................................... 86
3. Paramètre des boutons de validation ................................................................................................................................................... 86
3.1 KEY_VALIDATION_MOUSE ................................................................................................................................................................ 86
3.2 KEY_VALIDATION_KEYBOARD ......................................................................................................................................................... 86
13
3.3 KEY_CANCEL ...................................................................................................................................................................................... 86
4. Paramètre des touches du clavier ......................................................................................................................................................... 86
4.1 KEY_A ................................................................................................................................................................................................. 86
4.2 KEY_B ................................................................................................................................................................................................. 86
4.3 KEY_LEFT ........................................................................................................................................................................................... 86
4.4 KEY_RIGHT ......................................................................................................................................................................................... 87
4.5 KEY_UP ............................................................................................................................................................................................... 87
4.6 KEY_DOWN ........................................................................................................................................................................................ 87
5. Les informations du jeu ......................................................................................................................................................................... 87
5.1 MAJOR ................................................................................................................................................................................................ 87
5.2 MINOR ................................................................................................................................................................................................ 87
5.3 getGameVersion ................................................................................................................................................................................. 87
5.4 GAME_NAME ...................................................................................................................................................................................... 87
5.5 GAME_AUTHOR ................................................................................................................................................................................. 87
6. Paramètre Admob .................................................................................................................................................................................. 88
6.1 Id de la PUB ........................................................................................................................................................................................ 88
6.1.1 kAdMobAppID ............................................................................................................................................................................... 88
6.1.2 kBannerAdUnit ............................................................................................................................................................................. 88
6.1.3 kRewardedVideoAdUnit ............................................................................................................................................................... 88
6.2 Taille de la bannière de PUB ............................................................................................................................................................. 88
6.2.1 kBannerWidth ............................................................................................................................................................................... 88
6.2.2 kBannerHeight .............................................................................................................................................................................. 88
6.3 Publique cible de la PUB.................................................................................................................................................................... 88
6.3.1 kBirthdayDay ................................................................................................................................................................................ 88
6.3.2 kBirthdayMonth ............................................................................................................................................................................ 89
6.3.3 kBirthdayYear ............................................................................................................................................................................... 89
6.3.4 kKeywords .................................................................................................................................................................................... 89
7. Chemin des fichiers ressources du jeu .................................................................................................................................................. 89
7.1 GUI_DIR .............................................................................................................................................................................................. 89
7.2 FONT_DIR ........................................................................................................................................................................................... 89
7.3 SPRITES_DIR ...................................................................................................................................................................................... 89
7.4 TILES_DIR ........................................................................................................................................................................................... 89
7.5 SFX_DIR .............................................................................................................................................................................................. 89
7.6 MUSIC_DIR ......................................................................................................................................................................................... 90
8. Nom du package du jeu (Android) ........................................................................................................................................................ 90
9. Chemin des fichiers de sauvegarde ....................................................................................................................................................... 90
9.1 GAME_DATA_FILE ............................................................................................................................................................................. 90
9.2 CONFIG_FILE ...................................................................................................................................................................................... 90
9.3 GAME_PAD_FILE ................................................................................................................................................................................ 90
Activité .............................................................................................................................................................................................................. 90
1. class GameActivity .................................................................................................................................................................................. 90
2. Les éléments de GameActivity; .............................................................................................................................................................. 91
14
2.1 GameActivity ...................................................................................................................................................................................... 91
2.2 m_gameScene ..................................................................................................................................................................................... 91
2.3 onStart ................................................................................................................................................................................................ 91
2.4 onUpdate ............................................................................................................................................................................................ 91
2.5 onLeave .............................................................................................................................................................................................. 91
2.6 onExit ................................................................................................................................................................................................. 91
2.7 onEnter ............................................................................................................................................................................................... 91
2.8 onResume ........................................................................................................................................................................................... 91
2.9 onDraw ............................................................................................................................................................................................... 92
2.10 onEnd ............................................................................................................................................................................................. 92
Niveau ............................................................................................................................................................................................................... 92
1. Les niveaux ............................................................................................................................................................................................. 92
2. Intégration d’un niveau .......................................................................................................................................................................... 92
3. Les éléments pour gérer les niveaux ..................................................................................................................................................... 92
3.1 namespace level ................................................................................................................................................................................. 92
3.2 enum LevelId ..................................................................................................................................................................................... 92
3.3 getLevelMap ....................................................................................................................................................................................... 93
Langage du jeu .................................................................................................................................................................................................. 93
1. Les langues .............................................................................................................................................................................................. 93
2. Les éléments pour gérer les langues ..................................................................................................................................................... 93
2.1 namespace Lang ................................................................................................................................................................................ 93
2.2 enum GameLanguage ........................................................................................................................................................................ 93
Boite de Dialogue du jeu .................................................................................................................................................................................. 94
1. class GameDialog .................................................................................................................................................................................... 94
2. Les éléments de GameDialog ................................................................................................................................................................. 94
2.1 GameDialog ........................................................................................................................................................................................ 94
2.2 enum DialogIndex .............................................................................................................................................................................. 94
2.3 linkArrayToEnum .............................................................................................................................................................................. 95
2.4 step ..................................................................................................................................................................................................... 95
2.5 setDialog ............................................................................................................................................................................................. 96
2.6 setMouseInCollison ........................................................................................................................................................................... 96
2.7 draw .................................................................................................................................................................................................... 96
2.8 getDialogIndex ................................................................................................................................................................................... 96
2.9 getMouseInCollison ........................................................................................................................................................................... 96
2.10 showDialog .................................................................................................................................................................................... 96
Exemple de jeu ................................................................................................................................................................................................. 96
1. Introduction ............................................................................................................................................................................................ 96
2. Comment le jeu sera créé ? .................................................................................................................................................................... 97
2.1 Voici les éléments du moteur que le jeu utilisera ............................................................................................................................ 97
2.2 Les objets qui seront utilisés dans le jeu .......................................................................................................................................... 97
2.3 Les rôles des objets............................................................................................................................................................................ 97
3. Intégration des phrases dans le jeu ....................................................................................................................................................... 98
15
3.1 Création des phrases dans GameLanguage.h ................................................................................................................................... 98
3.2 Assoiciation de la boite de dialogue avec la phrase du jeu ............................................................................................................. 99
4. Création des classes du jeu .................................................................................................................................................................. 100
4.1 Classe Obstacle................................................................................................................................................................................. 100
4.1.1 Entête........................................................................................................................................................................................... 100
4.1.2 Implémentation .......................................................................................................................................................................... 101
4.1.2.1 Obstacle .................................................................................................................................................................................. 101
4.1.2.2 step .......................................................................................................................................................................................... 101
4.2 Classe Bonus .................................................................................................................................................................................... 101
4.2.1 Entête........................................................................................................................................................................................... 101
4.2.2 Implémentation .......................................................................................................................................................................... 102
4.2.2.1 Bonus ...................................................................................................................................................................................... 102
4.2.2.2 step .......................................................................................................................................................................................... 102
4.3 Classe Player .................................................................................................................................................................................... 102
4.3.1 Entête........................................................................................................................................................................................... 102
4.3.2 Implémentation .......................................................................................................................................................................... 103
4.3.2.1 Player ...................................................................................................................................................................................... 103
4.3.2.2 loadResources ........................................................................................................................................................................ 103
4.3.2.3 step .......................................................................................................................................................................................... 103
4.4 Classe HUD ....................................................................................................................................................................................... 105
4.4.1 Entête........................................................................................................................................................................................... 105
4.4.2 Implémentation .......................................................................................................................................................................... 106
4.4.2.1 HUD ......................................................................................................................................................................................... 106
4.4.2.2 loadResources ........................................................................................................................................................................ 106
4.4.2.3 step .......................................................................................................................................................................................... 106
4.4.2.4 draw ........................................................................................................................................................................................ 106
4.5 Classe MainMenu ............................................................................................................................................................................. 107
4.5.1 Entête........................................................................................................................................................................................... 107
4.5.2 Implémentation .......................................................................................................................................................................... 107
4.5.2.1 MainMenu ............................................................................................................................................................................... 107
4.5.2.2 loadResources ........................................................................................................................................................................ 107
4.5.2.3 componentsController ........................................................................................................................................................... 108
4.5.2.4 step .......................................................................................................................................................................................... 110
4.5.2.5 draw ........................................................................................................................................................................................ 111
4.6 Classe GameLevel ............................................................................................................................................................................ 112
4.6.1 Entête........................................................................................................................................................................................... 112
4.6.2 Implémentation .......................................................................................................................................................................... 113
4.6.2.1 GameLevel .............................................................................................................................................................................. 113
4.6.2.2 loadResources ........................................................................................................................................................................ 113
4.6.2.3 updateObjPlayer .................................................................................................................................................................... 115
4.6.2.4 playerLose .............................................................................................................................................................................. 115
4.6.2.5 updateObjObstacleList........................................................................................................................................................... 115
16
4.6.2.6 updateObjBonusList .............................................................................................................................................................. 116
4.6.2.7 updateBackground ................................................................................................................................................................. 117
4.6.2.8 gamePlay ................................................................................................................................................................................ 117
4.6.2.9 step .......................................................................................................................................................................................... 118
4.6.2.10 draw ........................................................................................................................................................................................ 119
5. Intégration et utilisation des scènes dans Activity ............................................................................................................................. 119
6. Amélioration ......................................................................................................................................................................................... 122
17
Guide de démarrage
1. Introduction
Bienvenue dans le guide d’utilisation du moteur de jeu is::Engine v2.1. Ce guide à pour objective de vous détailler
comment l’API fonctionne. Ce n’est pas un tutoriel même s’il y a un exemple qui vous montre comment utiliser le
moteur pour créer un jeu.
2. A propos du moteur
is::Engine est un outil qui se base sur les mécanismes de la bibliothèque SFML pour fonctionner. Donc si vous voulez
bien utiliser cet outil il est vivement conseillé de connaitre au minimum les bases de SFML. L’objectif de ce moteur est
de vous offrir des fonctinnalités qui vous permettent de créer un jeu avec le plus de souplesse possible et de le porter
facilement sur diverses plateformes (Windows, Linux, Android).
Le moteur est directement livré avec un IDE pour vous éviter les reconfigurations et de démarrer rapidement avec celui
ci. Notez que chaque IDE avec lequel le moteur est livré permet de porter votre projet sur une plateforme cible. Donc le
projet Android Studio vous permet d’utiliser le moteur pour développer sous Android.
L’entête qui permet d’avoir accès à la bibliothèque est : isEngine/core/GameEngine.h.
3. Structure du moteur
3.1 app_src
Repertoire qui contient le code source du jeu.
Description de ces sous-répertoires:
activity: Contient la classe Activity (cliquer ici 1 pour plus d’info) qui permet de lancer les différentes scènes
du jeu et d’assurer leurs interactions.
config: Contient le fichier GameConfig.cpp (cliquer ici 1 pour plus d’info) qui permet de définir les
paramètres généraux du jeu.
gamesystem_ext: Contient une classe dérivée (cliquer ici 1 pour plus d’info) de GameSystem (cliquer ici 1
pour plus d’info) qui permet de manipuler les données du jeu (sauvegarde, chargement, ...).
language: Contient le fichier GameLanguage.cpp (cliquer ici 1 pour plus d’info) qui permet de gérer tout ce
qui concerne les langues du jeu.
isEngine
app_src
config
data
scenes
objects
activity
levels
language
Le jeu
gamesyste
m_ext
Fichier
main.cpp
18
levels: Contient les niveaux et le fichier Level.h (cliquer ici 1 pour plus d’info) qui permet de les intégrer dans
le jeu.
objects: Contient les objets qui seront utilisés dans les différentes scènes.
scenes: Contient les différentes scènes du jeu (cliquer ici 1 pour plus d’info) (Introduction, Menu principal, ...).
3.2 isEngine
Repertoire qui contient le code source du moteur de jeu.
3.3 data
Repertoire des fichiers ressources du jeu (musiques, effets sonores, images, ...).
3.4 Fichier main.cpp
Ce fichier contient la fonction qui permet de lancer le programme.
3.4.1 main
int main()
Code Source
La fonction principale qui permet de lancer le moteur de jeu. A l’intérieur d’elle vous trouverez GameEngine game; qui
permet d’initialiser le moteur de jeu.
Retourne 0 quand le programme c’est bien terminé et une autre valeur s’il y a une erreur lors de l’éxécution.
3.4.2 game.play
game.play()
Code Source
Permet d’utiliser la boucle principale du moteur qui permet de lancer les différentes scènes du jeu (Introduction, Menu
principal, …).
3.4.3 game.basicSFMLmain
game.basicSFMLmain()
Code Source
Permet d’afficher une fenêtre SFML classique. Cette fonction vous permet d’utiliser votre propre boucle de rendu avec
le moteur. Très utile si vous désirez utiliser un projet SFML déjà en cour de développement avec le moteur ou d’intégrer
vos propres composant au moteur.
Display
1. class GameDisplay
class GameDisplay;
Entête : isEngine/system/display/GameDisplay.h
Code Source
Classe abstraite qui permet de créer la scène d’un jeu. Une scène est un endroit où les objets du jeu prennent vie (Menu
Principal, Niveau, …). Cette classe vous offre des fonctions qui vous permettent de manipuler facilement la vue,
19
appliquer les évenements de la fenêtre sur la scène, de faire des animations sur des textes et sprites, afficher des boites
de dialogue, …
2. Les méthodes publiques
2.1 GameDisplay
GameDisplay(sf::RenderWindow &window, sf::View &view, sf::RenderTexture &surface, GameSystemExtended
&gameSysExt, sf::Color bgColor)
Code Source
Constructeur qui permet de créer un object GameDisplay, elle prend en paramètre la fenêtre de l’application, la surface
de la bibliotéque SWOOSH qui permet de faire des effets transitions, GameSystemExtended (cliquer ici 1 pour plus
d’info) et la couleur de fond de la scène.
2.2 setAdmob
virtual void setAdmob(AdmobManager *admob)
Code Source
Permet d’intégrer le gestionnaire d’annonce (Admob) dans une scène.
2.3 rewardVideoStep
virtual int rewardVideoStep()
Code Source
Permet de lancer une annonce de type vidéo récompense.
Retourne 1 si la vidéo récompense c’est bien lancé et 0 s‘il y a une erreur (se produit souvent quand la requête de
l’annonce n’a pas fonctionné).
2.4 step
virtual void step() = 0
Code Source
Méthode qui permet d’implémenter la partie où les objets de la scène sont mise à jour (déplacement des objets,
détections de collision, …).
Note : Lorsque le SDM est activé et que l'utilisateur ne surcharge pas cette fonction, le SDM prend soin d'appeler
cette méthode pour mettre à jour automatiquement les objets de la scène et les événements de la fenêtre.
2.5 draw
virtual void draw() = 0
Code Source
Méthode qui permet d’implémenter la partie où les objets de la scène seront déssinés.
Note : Lorsque le SDM est activé et que l'utilisateur ne surcharge pas cette fonction, le SDM prend soin d'appeler
cette méthode pour afficher automatiquement les objets de la scène.
2.6 drawScreen
virtual void drawScreen()
Code Source
20
Méthode qui permet d’afficher les objets de la scène.
2.7 showTempLoading
virtual void showTempLoading(float time = 3.f * 59.f)
Code Source
Permet d’afficher un faux écran de chargement (Utile pour faire des transitions dans la même scène).
Paramètre time représente la durée (en milliseconde) du chargement.
2.8 setOptionIndex
Première forme :
void setOptionIndex(int optionIndexValue, bool callWhenClick, float buttonScale = 1.3f)
Code Source
Permet de faire des animations sur des textes et de jouer un son quand on change une option.
Deuxième forme :
void setOptionIndex(int optionIndexValue)
Code Source
Permet de change une option.
2.9 setTextAnimation
Première forme :
void setTextAnimation(sf::Text &txt, sf::Sprite &spr, int val)
Code Source
Permet de faire une animation sur un texte et un sprite en fonction du choix d’une option.
Deuxième forme :
void setTextAnimation(sf::Text &txt, int &var, int val)
Code Source
Permet de faire une animation sur un texte en fonction du choix d’une option.
2.10 setView
void setView()
Code Source
Met à jour la position de la vue dans la scène.
2.11 loadParentResources
virtual bool loadParentResources()
Code Source
Charge les ressources qui permettent d’afficher les boites de dialogues dans une scène.
21
Elle est généralement utilisée dans la fonction loadResources d’une scène.
2.12 loadResources
virtual bool loadResources() = 0
Code Source
Permet d’implémenter le chargement des ressources qui sont utilisés dans une scène.
2.13 setIsRunning
void setIsRunning(bool val)
Code Source
Permet de définir l’état d’éxécution de la scène.
2.14 setIsPlaying
void setIsPlaying(bool val)
Code Source
Permet de définir la variable m_isPlaying.
2.15 setSceneStart
void setSceneStart(bool val)
Code Source
Permet de définir la variable m_sceneStart.
2.16 setSceneEnd
void setSceneEnd(bool val)
Code Source
Permet de définir la variable m_sceneEnd.
2.17 setKeyBackPressed
void setKeyBackPressed(bool val)
Code Source
Permet de définir la variable m_keyBackPressed.
2.18 isRunning
virtual bool isRunning() const
Code Source
Retourne vrai si une scène est en cours d’exécution et faux si non.
2.19 getIsPlaying
virtual bool getIsPlaying() const
Code Source
22
Retourne vrai si une scène est active et faux si non.
2.20 getSceneStart
virtual bool getSceneStart() const
Code Source
Retourne vrai si une scène est à son début d’éxécution et faux si non.
2.21 getSceneEnd
virtual bool getSceneEnd() const
Code Source
Retourne vrai si une scène arrive à sa fin d’éxécution et faux si non.
2.22 getWindowIsActive
virtual bool getWindowIsActive() const
Code Source
Retourne vrai si la fenêtre est active et faux si non.
2.23 getKeyBackPressed
virtual bool getKeyBackPressed() const
Code Source
Retourne la valeur de la vraiable m_keyBackPressed.
2.24 getView
virtual sf::View& getView() const
Code Source
Retourne la vue d’une scène.
2.25 getRenderWindow
virtual sf::RenderWindow& getRenderWindow()
Code Source
Retourne la fenêtre d’exécution de la scène.
2.26 getRenderTexture
virtual sf::RenderTexture& getRenderTexture() const
Code Source
Retourne la surface sur laquelle on déssine les objets d’une scène.
2.27 getGameSystem
virtual GameSystemExtended& getGameSystem()
Code Source
23
Retourne l’objet game system extended.
2.28 getFontSystem
virtual sf::Font& getFontSystem()
Code Source
Retourne la police du système.
2.29 getFontMsg
virtual sf::Font& getFontMsg()
Code Source
Retourne la police de la boite de dialogue.
2.30 getSprButtonSelect
virtual sf::Sprite& getSprButtonSelect()
Code Source
Retourne le Sprite de sélection d’option.
2.31 getOptionIndex
virtual int getOptionIndex()
Code Source
Retourne l’option chosie.
2.32 getSceneWidth
virtual unsigned int getSceneWidth()
Code Source
Retourne la largeur de la scène.
2.33 getSceneHeight
virtual unsigned int getSceneHeight()
Code Source
Retourne la hauteur de la scène.
2.34 getDeltaTime
virtual float getDeltaTime()
Code Source
Retourne le temps d’exécution en seconde.
2.35 getDELTA_TIME
virtual float getDELTA_TIME() const
Code Source
24
Retourne la variable DELTA_TIME.
2.36 getSprButtonSelectScale
virtual float& getSprButtonSelectScale()
Code Source
Retourne l’echelle du Sprite de sélection.
2.37 getViewX
virtual float getViewX() const
Code Source
Retourne la position x de la vue.
2.38 getViewY
virtual float getViewY() const
Code Source
Retourne la position y de la vue.
2.39 getViewW
virtual float getViewW() const
Code Source
Retourne la largeur de la vue.
2.40 getViewH
virtual float getViewH() const
Code Source
Retourne la hauteur de la vue.
2.41 getBgColor
virtual sf::Color& getBgColor()
Code Source
Retourne la couleur de fond de la scène.
2.42 inViewRec
virtual bool inViewRec(MainObject *obj, bool useTexRec = true)
Code Source
Retourne vrais si l’objet se trouve dans le champ de vision de la vue, faux si non.
2.43 mouseCollision
Première forme
template <class T>
25
bool mouseCollision(T const &obj
#if defined(__ANDROID__)
, unsigned int finger = 0
#endif
)
Code Source
Windows, Linux : Détecte si le curseur de la souris est en collision avec un objet de la scène.
Android : Détecte si l’utilisateur touche un objet de la scène.
Paramètre :
obj l’objet avec lequel on veut faire le test.
finger représente l’index du doigt.
Retourne vrais si il y a collision et faux si non.
Exemple :
if (mouseCollision(sprite))
{
// do something
}
Deuxième forme
template <class T>
bool mouseCollision(T const &obj, sf::RectangleShape &cursor
#if defined(__ANDROID__)
, unsigned int finger = 0
#endif
)
Code Source
Windows, Linux : Détecte si le curseur de la souris est en collision avec un objet de la scène.
Android : Détecte si l’utilisateur touche un objet de la scène.
Paramètre :
obj l’objet avec lequel on veut faire le test.
cursor permet de récupérer la position du point de collision.
finger représente l’index du doigt.
Retourne vrais si il y a collision et faux si non.
Exemple :
sf::ReactangleShape rec;
if (mouseCollision(sprite, rec))
26
{
float cursorXPosition = rec.getPosition.x();
float cursorYPosition = rec.getPosition.y();
}
2.44 SDMmanageScene
virtual void SDMmanageScene()
Code Source
Permet de gérer toutes les parties de la scene (évènement, mise à jour, affichage, boite de dialogue).
2.45 SDMmanageSceneEvents
virtual void SDMmanageSceneEvents()
Code Source
Permet de définir la façon dont le SDM va gérer les évènements de la fenêtre. Pour changer le mécanisme surcharger
cette méthode.
2.46 SDMmanageSceneMsgAnswers
virtual void SDMmanageSceneMsgAnswers()
Code Source
Permet de définir la façon dont les réponses de la boite de dialogue seront gérées par le SDM. Pour changer le
mécanisme surcharger cette méthode.
2.47 SDMstep
virtual void SDMstep()
Code Source
Permet de mettre à jour les objets qui se trouvent dans le conteneur du SDM.
2.48 SDMdraw
virtual void SDMdraw()
Code Source
Permet d’afficher les objets qui se trouvent dans le conteneur du SDM.
2.49 GSMplaySound
virtual void GSMplaySound(std::string name)
Code Source
Permet de jouer un son gérer par le GSM.
2.50 GSMpauseSound
virtual void GSMpauseSound(std::string name)
Code Source
Permet de mettre en pause un son gérer par le GSM.
27
2.51 GSMplayMusic
virtual void GSMplayMusic(std::string name)
Code Source
Permet de jouer une musique gérer par le GSM.
2.52 GSMpauseMusic
virtual void GSMpauseMusic(std::string name)
Code Source
Permet de mettre en pause une musique gérer par le GSM.
3. Éléments protégés
3.1 enum MsgAnswer
enum MsgAnswer;
Enumérateur
YES
Réponse Oui
NO
Réponse Non
Code Source
Représente les réponses que l’utilisateur peut choisir par rapport à la boite de dialogue.
3.2 controlEventFocusClosing
void controlEventFocusClosing()
Code Source
Gère les événements focus et fermeture de la fenêtre. S’utilise dans une boucle d’événement !
3.3 showMessageBox
template<class T>
void showMessageBox(T const &msgBody, bool mbYesNo = true)
Code Source
Definie les paramètres et affiche la boite de dialogue.
Paramètre :
msgBody le message qui sera affiché à l’utilisateur.
mbYesNo vrais affiche une boite de dialogue de type OUI NON et faux affiche juste un bouton OK.
3.4 updateMsgBox
void updateMsgBox(float const &DELTA_TIME, sf::Color textDefaultColor = sf::Color::White, sf::Color textSelectedColor
= sf::Color::Red)
Code Source
Met à jour les informations de la boite de dialogue.
28
Paramètre :
textDefaultColor couleur du text du message.
textSelectedColor couleur des textes des boutons.
3.5 updateTimeWait
void updateTimeWait(float const &DELTA_TIME)
Code Source
Met à jour le compteur qui permet de faire patienter l’utilisateur après le choix d’une option. Ceci permet d’éviter les
choix en boucles.
3.6 drawMsgBox
void drawMsgBox()
Code Source
Affiche la boite de dialogue.
SDM (Step and Draw Manager)
1. class SDM
class SDM;
Entête : isEngine/system/display/SDM.h
Code Source
Classe parent qui permet à une scène d’utiliser les fonctions qui mettent à jour et affichent automatiquement les objects
d’une scène. Elle permet aussi de gérer la profondeur d’affichage des objets.
2. Les éléments publics de SDM
2.1 m_SDMsceneObjects
std::vector<std::shared_ptr<MainObject>> m_SDMsceneObjects
Code Source
Conteneur qui permet de stocker les objects (dérivés de la classe MainObject) de la scène qui seront gérés par le SDM.
2.2 SDMgetObject
MainObject* SDMgetObject(std::string name)
Code Source
Retourne un object qui se trouve dans le conteneur en fonction de son nom.
Exemple :
auto player = SDMgetObject("Player");
player->setX(777.f);
2.3 SDMaddSceneObject
29
template <class T>
void SDMaddSceneObject(std::shared_ptr<T> obj, bool callStepFunction = true, bool callDrawFunction = true,
std::string name = "null")
Code Source
Permet d’ajouter un objet dans le conteneur.
Paramètre :
obj l’objet à ajouter.
callStepFunction permet de savoir si le SDM doit mettre à jour l’objet.
callDrawFunction permet de savoir si le SDM doit déssiner l’objet.
name permet de donner un nom à l’objet lors de l’ajout.
2.4 SDMaddSprite
virtual void SDMaddSprite(sf::Sprite &spr, std::string name, int depth = DepthObject::NORMAL_DEPTH)
Code Source
Permet d’ajouter un Sprite SFML dans le conteneur. Elle ne fera pas partie des objets à mettre à jour mais de ceux qui
seront affichés. Le Sprite sera associé à un objet de type MainObject.
2.5 SDMsetObjDepth
virtual void SDMsetObjDepth(std::string name, int depth)
Code Source
Permet de définir la profondeur d’affichage d’un objet.
Game Sound
1. class GameSound
class GameSound;
Entête : isEngine/system/sound/GameSound.h
Code Source
Classe qui permet d’utiliser les sons dans le jeu.
2. Les éléments publics de GameSound
2.1 GameSound
GameSound(std::string soundName, std::string filePath)
Code Source
Constructeur qui permet de charger un son et de lui donner un nom.
2.2 loadResources
void loadResources(std::string filePath)
30
Code Source
Permet de charger le son.
2.3 getSoundBuffer
sf::SoundBuffer& getSoundBuffer()
Code Source
Retourne l’instance Sound Buffer.
2.4 getSound
sf::Sound& getSound()
Code Source
Retourne l’instance Sound.
Game Music
1. class GameMusic
class GameMusic;
Entête : isEngine/system/sound/GameMusic.h
Code Source
Classe qui permet d’utiliser les musiques dans le jeu.
2. Les éléments publics de GameMusic
2.1 GameMusic
GameMusic(std::string musicName, std::string filePath)
Code Source
Constructeur qui permet de charger une musique et de lui donner un nom.
2.2 loadResources
void loadResources(std::string filePath)
Code Source
Permet de charger la musique.
2.3 getMusic
sf::Music& getMusic()
Code Source
Retourne l’instance Music.
GSM (Game Sound System)
31
1. class GSM
class GSM;
Entête : isEngine/system/sound/GSM.h
Code Source
Classe parent qui permet à une scène d’ajouter et d’utiliser des sons / musiques sans initialiser les objets SFML.
2. Les éléments publics de GSM
2.1 Les Conteneurs du GSM
std::vector<std::shared_ptr<GameSound>> m_GSMsound
std::vector<std::shared_ptr<GameMusic>> m_GSMmusic
Code Source
Conteneur qui permet de stocker les sons / musiques de la scène qui seront gérés par le GSM.
2.2 GSMaddSound
virtual void GSMaddSound(std::string name, std::string filePath)
Code Source
Permet d’ajouter un son dans le conteneur.
Paramètre :
name nom du son.
filePath chemin du fichier son.
2.3 GSMaddMusic
virtual void GSMaddMusic(std::string name, std::string filePath)
Code Source
Permet d’ajouter une musique dans le conteneur.
Paramètre :
name nom de la musique.
filePath chemin du fichier musique.
2.4 GSMgetSound
virtual sf::Sound* GSMgetSound(std::string name)
Code Source
Retourne un son qui se trouve dans le conteneur en fonction de son nom.
2.5 GSMgetMusic
virtual sf::Music* GSMgetMusic(std::string name)
Code Source
32
Retourne une musique qui se trouve dans le conteneur en fonction de son nom.
Entités
1. class MainObject
class MainObject;
Entête : isEngine/system/entity/MainObject.h
Code Source
Classe de base pour créer les objets (Personnage, Tuiles, Bouton, …) qui seront utilisées dans les scènes. Elle vous offre
des fonctions qui vous permettent de contrôler un objet (les déplacements, détections de collision entre les objets,
calcul de distance, …) et plein d’autres choses qui sont liées au game play du jeu.
2. Les éléments publics de MainObjet
2.1 MainObject
Première forme
MainObject()
Code Source
Constructeur par défaut de la classe.
Deuxième forme
MainObject(float x, float y)
Code Source
Constructeur qui permet d’initialiser l’objet avec un point de départ.
Troisième forme
MainObject(sf::Sprite &spr, float x = 0.f, float y = 0.f)
Code Source
Constructeur qui permet d’initialiser l’objet avec un Sprite et un point de départ.
2.2 instanceNumber
static int instanceNumber;
Code Source
Retourne le nombre d’instance de la classe.
2.3 m_SDMcallStep
bool m_SDMcallStep
Code Source
Permet de savoir si le SDM peut utiliser la méthode step() (de mise à jour) de l’objet.
2.4 m_SDMcallDraw
33
bool m_SDMcallDraw
Code Source
Permet de savoir si le SDM peut utiliser la méthode draw() (d’affichage) de l’objet.
2.5 setXStart
virtual void setXStart(float x)
Code Source
Definie la position x de début.
2.6 setYStart
virtual void setYStart(float y)
Code Source
Definie la position y de début.
2.7 setXPrevious
virtual void setXPrevious(float x)
Code Source
Definie la position x précédente.
2.8 setYPrevious
virtual void setYPrevious(float y)
Code Source
Définie la position y précédente.
2.9 setStartPosition
virtual void setStartPosition(float x, float y)
Code Source
Définie la position x et y de début.
2.10 setX
virtual void setX(float x)
Code Source
Définie la position x.
2.11 setY
virtual void setY(float y)
Code Source
Définie la position y.
2.12 moveX
34
virtual void moveX(float x)
Code Source
Permet de bouger l’objet sur l’axe des x.
2.13 moveY
virtual void moveY(float y)
Code Source
Permet de bouger l’objet sur l’axe des y.
2.14 setPosition
virtual void setPosition(float x, float y)
Code Source
Définie la position x et y.
2.15 setSpriteScale
virtual void setSpriteScale(float x, float y)
Code Source
Définie l’échelle x et y du spirite de l’objet.
2.16 setSpeed
virtual void setSpeed(float val)
Code Source
Définie la vitesse de l’objet.
2.17 setHsp
virtual void setHsp(float val)
Code Source
Définie la vitesse horizontal.
2.18 setVsp
virtual void setVsp(float val)
Code Source
Définie la vitesse vertical.
2.19 setAngularMove
virtual void setAngularMove(float const &DELTA_TIME, float speed, float angle)
Code Source
Permet de bouger l’objet en fonction d’un angle et d’une vitesse.
2.20 setImageXscale
35
virtual void setImageXscale(float val)
Code Source
Définie l’échelle x de l’objet.
2.21 setImageYscale
virtual void setImageYscale(float val)
Code Source
Définie l’échelle y de l’objet.
2.22 setImageScale
virtual void setImageScale(float val)
Code Source
Définie l’échelle x et y de l’objet avec une même valeur.
2.23 setImageAngle
virtual void setImageAngle(float val)
Code Source
Définie l’angle de l’objet.
2.24 setXOffset
virtual void setXOffset(float val)
Code Source
Définie le décalage x de l’objet.
2.25 setYOffset
virtual void setYOffset(float val)
Code Source
Définie le décalage y de l’objet.
2.26 setXYOffset
virtual void setXYOffset()
Code Source
Définie le décalage x et y de l’objet avec une même valeur.
2.27 setTime
void setTime(float x)
Code Source
Définie la valeur de la variable m_time de l’objet.
2.28 setImageAlpha
36
virtual void setImageAlpha(int val)
Code Source
Définie l’image alpha de l’objet.
2.29 setImageIndex
virtual void setImageIndex(int val)
Code Source
Définie la sous image de l’objet.
2.30 setMaskW
virtual void setMaskW(unsigned int val)
Code Source
Définie la largeur du masque de collision de l’objet.
2.31 setMaskH
virtual void setMaskH(unsigned int val)
Code Source
Définie la hauteur du masque de collision de l’objet.
2.32 setIsActive
virtual void setIsActive(bool val)
Code Source
Définie l’état d’activité de l’objet.
2.33 updateCollisionMask
Première forme :
virtual void updateCollisionMask()
Code Source
Met à jour les informations (taille, position, …) du masque de collision.
Deuxième forme:
virtual void updateCollisionMask(int x, int y)
Code Source
Met à jour la position du masque de collision en fonction d’un point x et y différents de celui de l’objet.
2.34 centerCollisionMask
virtual void centerCollisionMask(int x, int y)
Code Source
Centre la position du masque de collision en fonction d’un point x et y.
37
2.35 updateSprite
Premier forme
virtual void updateSprite()
Code Source
Met à jour le sprite de l’objet avec les valeurs des variables (alpha, scale, …) qui se trouvent dans l’objet.
Deuxième forme
virtual void updateSprite(float x, float y, float angle = 0.f, int alpha = 255, float xScale = 1.f, float yScale = 1.f)
Code Source
Met à jour le sprite de l’objet avec des valeurs externes.
2.36 draw
virtual void draw(sf::RenderTexture &surface)
Code Source
Permet d’afficher l’objet.
2.37 drawMask
virtual void drawMask(sf::RenderTexture &surface, sf::Color color = sf::Color::Blue)
Code Source
Permet d’afficher le masque de collision qui a été défini (Rectangle ou Cercle) pour l’objet.
2.38 getMask
virtual is::Rectangle getMask() const
Code Source
Retourne le masque de collision rectangle (par défaut).
2.39 getCircleMask
virtual is::Circle getMask() const
Code Source
Retourne le masque de collision cercle.
2.40 getX
virtual float getX() const
Code Source
Retourne la position x de l’objet.
2.41 getY
virtual float getY() const
Code Source
38
Retourne la position y de l’objet.
2.42 getXStart
virtual float getXStart() const
Code Source
Retourne la position x de début de l’objet.
2.43 getYStart
virtual float getYStart() const
Code Source
Retourne la position y de début de l’objet.
2.44 getXPrevious
virtual float getXPrevious() const
Code Source
Retourne la position x précédente de l’objet.
2.45 getYPrevious
virtual float getYPrevious() const
Code Source
Retourne la position y précédente de l’objet.
2.46 distantToPoint
virtual float distantToPoint(float x, float y) const
Code Source
Retourne la distance entre l’objet et un point x et y.
2.47 distantToObject
virtual float distantToObject(std::shared_ptr<MainObject> const &other, bool useSpritePosition) const
Code Source
Retourne la distance entre l’objet et un autre.
Paramètre si useSpritePosition est vrais on utilise la position du sprite de l’objet pour faire le test si non on utilise la
position x, y de l’objet.
2.48 pointDirection
Première forme
virtual float pointDirection(float x, float y) const
Code Source
Retourne la direction (angle) de l’objet par rapport à un point.
39
Deuxième forme
virtual float pointDirection(std::shared_ptr<MainObject> const &other) const
Code Source
Retourne la direction (angle) de l’objet par rapport à un autre. Ici l’autre objet est un pointeur.
2.49 pointDirectionSprite
Première forme
virtual float pointDirectionSprite(float x, float y) const
Code Source
Retourne la direction (angle) du sprite de l’objet par rapport à un point.
Deuxième forme
virtual float pointDirectionSprite(std::shared_ptr<MainObject> const &other) const
Code Source
Retourne la direction (angle) du sprite de l’objet par rapport à un autre.
2.50 getSpeed
virtual float getSpeed() const
Code Source
Retourne la vitesse de l’objet.
2.51 getHsp
virtual float getHsp() const
Code Source
Retourne la vitesse horizontale de l’objet.
2.52 getVsp
virtual float getVsp() const
Code Source
Retourne la vitesse verticale de l’objet
2.53 getFrame
virtual float getFrame() const
Code Source
Retourne le numéro du sous image qui est en cours d’affichage.
2.54 getFrameStart
virtual float getFrameStart() const
Code Source
40
Retourne le numéro du sous image de début.
2.55 getFrameEnd
virtual float getFrameEnd() const
Code Source
Retourne le numéro du sous image de fin.
2.56 getImageXscale
virtual float getImageXscale() const
Code Source
Retourne l’échelle x de l’objet.
2.57 getImageYscale
virtual float getImageYscale() const
Code Source
Retourne l’échelle y de l’objet.
2.58 getImageScale
virtual float getImageScale() const
Code Source
Retourne l’échelle de l’objet.
2.59 getImageAngle
virtual float getImageAngle() const
Code Source
Retourne l’angle de l’image de l’objet.
2.60 getXOffset
virtual float getXOffset() const
Code Source
Retourne le décallage en x de l’objet.
2.61 getYOffset
virtual float getYOffset() const
Code Source
Retourne le décallage en y de l’objet.
2.62 getTime
virtual float getTime() const
Code Source
41
Retourne la valeur de la variable m_time.
2.63 getInstanceId
virtual int getInstanceId() const
Code Source
Retourne le numéro de l’objet.
2.64 getMaskW
virtual unsigned int getMaskW() const
Code Source
Retourne la largeur du masque de collision.
2.65 getMaskH
virtual unsigned int getMaskH() const
Code Source
Retourne la hauteur du masque de collision.
2.66 getIsActive
virtual bool getIsActive() const
Code Source
Retourne l’état de l’objet.
2.67 getImageAlpha
virtual int getImageAlpha() const
Code Source
Retourne l’image alpha de l’objet.
2.68 getImageIndex
virtual int getImageIndex() const
Code Source
Retourne l’index de l’image.
2.69 getSpriteWidth
virtual int getSpriteWidth() const
Code Source
Retourne la largeur du sprite.
2.70 getSpriteHeight
virtual int getSpriteHeight() const
Code Source
42
Retourne la hauteur du sprite.
2.71 getSpriteX
virtual float getSpriteX() const
Code Source
Retourne la position x du sprite.
2.72 getSpriteY
virtual float getSpriteY() const
Code Source
Retourne la position y du sprite.
2.73 getSpriteCenterX
virtual int getSpriteCenterX() const
Code Source
Retourne le centre x du sprite.
2.74 getSpriteCenterY
virtual int getSpriteCenterY() const
Code Source
Retourne le centre y du sprite.
2.75 placeMetting
Première forme
virtual bool placeMetting(int x, int y, MainObject const *other)
Code Source
Retourne vrai s’il y a collision avec un autre objet, faux si non.
Deuxième forme
virtual bool placeMetting(int x, int y, std::shared_ptr<MainObject> const &other)
Code Source
Retourne vrai s’il y a collision avec un autre objet, faux si non. Ici l’autre objet est un pointeur.
2.76 getSprite
virtual sf::Sprite& getSprite()
Code Source
Retourne le sprite de l’objet.
2.77 setFrame
virtual void setFrame(float frameStart, float frameEnd = -1.f)
43
Code Source
Définie l’image de début et de fin qui servira à faire l’animation du sprite de l’objet.
3. Autres fonctions de MainObject
3.1 instanceExist
Première forme
template<class T>
bool instanceExist(std::shared_ptr<T> const &obj)
Code Source
Retourne vrai si l’instance existe, faux si non.
Deuxième forme
template<class T>
bool instanceExist(T const *obj)
Code Source
Retourne vrai si l’instance existe, faux si non.
3.2 operator()
Comparateur de position
class CompareX;
Code Source
Foncteur qui sert à trier les objets par rapport à leur position x.
bool operator()(std::shared_ptr<MainObject> const &a, std::shared_ptr<MainObject> const &b) const
Code Source
Sert à trier les objets en fonction de leurs positions x.
Comparateur de profondeur
class CompareDepth;
Code Source
Foncteur qui sert à trier les objets par rapport à leur profondeur.
bool operator()(std::shared_ptr<MainObject> const &a, std::shared_ptr<MainObject> const &b) const
Code Source
Sert à trier les objets en fonction de leurs profondeurs.
3.3 sortObjArrayByX
template<class T>
void sortObjArrayByX(std::list<std::shared_ptr<T>> &v)
Code Source
44
Trie un tableau (std::list) d’objets en fonction de la position x.
3.4 sortObjArrayByDepth
template<class T>
void sortObjArrayByDepth(std::list<std::shared_ptr<T>> &v)
Code Source
Trie un tableau (std::list) d’objets en fonction de la profondeur.
3.5 operator>
bool operator<(std::shared_ptr<MainObject> const &a, const MainObject &b)
Code Source
Retourne vrai si la position de l’objet A est supérieur à celui de B, faux si non.
3.6 operator<
bool operator<(const MainObject &b, std::shared_ptr<MainObject> const &a)
Code Source
Retourne vrai si la position de l’objet A est inférieur à celui de B, faux si non.
Les formes pour les masques collisions
Entête : isEngine/system/entity/Form.h
1. class Rectangle
class Rectangle;
Code Source
Représente le masque de collision rectangle. Ces membres m_left, m_top, m_right, m_bottom permettent de définir la
taille du masque.
2. class Circle
class Circle;
Code Source
Représente le masque de collision cercle. Ces membres m_x, m_y, m_raduis permettent de définir la position et le
rayon du cercle.
Circle()
Code Source
Constructeur par défaut.
Les Classes Parentes de MainObject
45
1. class DepthObject
class DepthObject;
Entête : isEngine/system/entity/parents/DephObject.h
Code Source
Classe qui offre des méthodes pour gérer la profondeur d’affichage des objets dans une scène.
1.1 enum Depth
enum Depth;
Enumérateur
VERY_BIG_DEPTH
Très Grande profondeur
BIG_DEPTH
Grande profondeur
NORMAL_DEPTH
Profondeur normal
SMALL_DEPTH
Petite profondeur
VERY_SMALL_DEPTH
Très petite profondeur
Code Source
Représente le niveau de profondeur d’un objet.
1.2 DepthObject
DepthObject(int Depth)
Code Source
Constructeur pour définir une profondeur.
1.3 setDepth
virtual void setDepth(int val)
Code Source
Définie la profondeur de l’objet.
1.4 getDepth
virtual int getDepth() const
Code Source
Retourne la profondeur de l’objet.
2. class Destructible
class Destructible;
Entête : isEngine/system/entity/parents/Destructible.h
Code Source
Classe qui offre des méthodes pour gérer la destruction d’un objet.
2.1 Destructible
Destructible()
46
Code Source
Constructeur par défaut.
2.2 setDestroyed
virtual void setDestroyed()
Code Source
Enclenche la destruction d’un objet.
2.3 isDestroyed
virtual bool isDestroyed() const
Code Source
Retourne l’état de l’objet.
3. class Visibility
class Visibility;
Entête : isEngine/system/entity/parents/Visibility.h
Code Source
Class qui offre des méthodes pour gérer la visibilité d’un objet.
3.1 Visibility
explicit Visibility(bool defaultVisibility = true)
Code Source
Constructeur de la classe.
3.2 setVisible
void setVisible(bool value)
Code Source
Définie la visibilité de l’objet.
3.3 getVisible
bool getVisible() const
Code Source
Retourne l’état de l’objet.
4. class Health
class Health;
Entête : isEngine/system/entity/parents/Health.h
Code Source
Class qui offre des méthodes pour gérer la santé d’un objet.
47
4.1 Health
Prémière forme
Health(int health)
Code Source
Constructeur de la classe, prend en paramètre la santé à attribuer à l’objet. Ici la valeur maximale de la santé est égale à
la santé définie.
Deuxième forme
Health(int health, int maxHealth)
Code Source
Constructeur de la classe prend en paramètre la santé à attribuer à l’objet et la valeur maximale.
4.2 setHealth
virtual void setHealth(int val)
Code Source
Définie la santé de l’objet.
4.3 setMaxHealth
virtual void setMaxHealth(int val)
Code Source
Définie la santé maximale (la limite à ne pas dépasser) de l’objet.
4.4 addHealth
virtual void addHealth(int val = 1)
Code Source
Ajoute la santé à l’objet. Peut servir aussi à le retancher si on met une valeur négative.
4.5 getHealth
virtual int getHealth() const
Code Source
Retourne la santé de l’objet.
4.6 getMaxHealth
virtual int getMaxHealth() const
Code Source
Retourne la santé maximale (la limite à ne pas dépasser) de l’objet.
5. class HurtEffect
class HurtEffect;
48
Entête : isEngine/system/entity/parents/HurtEffect.h
Code Source
Classe qui offre des méthodes pour faire un effet invulnérabilité sur un objet. C'est-à-dire faire clignoter l’objet pendant
un certain temps (e.g. quand le joueur est attaqué par un ennemi il devient invunérable en clignotant pendant une
durrée limitée).
5.1 HurtEffect
HurtEffect(sf::Sprite &sprParent) :
Code Source
Constructeur de la classe prend en paramètre le sprite sur lequel l’effet invunérabilité sera éffectué.
5.2 hurtStep
void hurtStep(float const &DELTA_TIME)
Code Source
Permet de faire l’animation d’invunérabilté.
5.3 setIsHurt
void setIsHurt(float durration = 100.f)
Code Source
Définie la durrée (en milliseconde) de l’invunérabilité de l’objet.
5.4 getIsHurt
bool getIsHurt() const
Code Source
Retourne vrai si l’objet est invunérable, faux si non.
6. class ScorePoint
class ScorePoint;
Entête : isEngine/system/entity/parents/ScorePoint.h
Code Source
Classe qui offre des méthodes pour gérer le score à attribuer à un objet (e.g. chaque ennemi possède un point
particulier lors de sa création qu’on ajoute au score global du joueur quand il est vaincu).
6.1 ScorePoint
explicit ScorePoint(int point = 0)
Code Source
Constructeur de la classe, prend en paramètre le point à attribuer à l’objet.
6.2 setScorePoint
virtual void setScorePoint(int point)
49
Code Source
Définie le point de l’objet.
6.3 getScorePoint
virtual int getScorePoint() const
Code Source
Retourne le point attribué à l’objet.
7. class Step
class Step;
Entête : isEngine/system/entity/parents/Step.h
Classe qui offre des méthodes pour gérer les differents étapes d’un objet (e.g. pour faire décoler une fusé il faut passer
par plusieurs étapes).
7.1 Step
explicit Step(int step = 0)
Code Source
Constructeur de la classe.
7.2 setStep
virtual void setStep(int val)
Code Source
Définie l’étape de l’objet.
7.3 addStep
virtual void addStep()
Code Source
Avance l’étape de l’objet.
7.4 reduceStep
virtual void reduceStep()
Code Source
Réduit l’etape de l’objet.
7.5 getStep
virtual int getStep() const
Code Source
Retourne l’étape à laquelle l’objet est.
8. class Name
50
class Name;
Entête : isEngine/system/entity/parents/Name.h
Classe parent qui offre des méthodes pour gérer le nom d’un objet.
8.1 Name
explicit Name(std::string name = "Unknown")
Code Source
Constructeur qui permet de définir le nom de l’objet.
8.2 setName
void setName(std::string soundName)
Code Source
Permet de définir le nom de l’objet.
8.3 getName
std::string getName() const
Code Source
Retourne le nom de l’objet.
9. class FilePath
class FilePath;
Entête : isEngine/system/entity/parents/FilePath.h
Classe parent qui offre des méthodes pour gérer le chemin d’un fichier.
9.1 FilePath
FilePath(std::string filePath)
Code Source
Constructeur de la classe, elle prend en paramètre le chemin du fichier à charger.
9.2 setFilePath
void setFilePath(std::string filePath)
Code Source
Permet de définir le chemin du fichier.
9.3 getFilePath
std::string getFilePath() const
Code Source
Retourne le chemin du fichier.
9.4 getFileIsLoaded
51
bool getFileIsLoaded() const
Code Source
Retourne vrais quand le fichier a été bien chargé faux sinon.
Le Backgroud
1. class Background
class Background;
Entête : isEngine/system/entity/Background.h
Code Source
Cette Classe permet de déssiner un Sprite sous forme d’arrière plan, avec la possibilité de l’utiliser pour remplir une
scène et de le faire défiler avec une vitesse horizontale et verticale.
2. Les méthodes publiques
2.1 Background
Background(sf::Texture &tex, float x, float y, is::GameDisplay *scene, float hSpeed = 0.f, float vSpeed = 0.f,
bool fillHorizontal = true, bool fillVertical = true)
Code Source
Constructeur de la classe, elle prend en paramètre la texture, la position, la scene, la vitesse de défilement horizontale et
vertciale et les deux autres paramètres qui servent à faire le remplissage horizontal et vertical.
2.2 step
void step(float const &DELTA_TIME)
Code Source
Permet de mettre à jour l’objet.
Admob
1. class AdmobManager
class AdmobManager;
Entête : isEngine/system/android/AdmobManager.h
Code Source
Classe qui permet d’utiliser le SDK Admob dans le jeu. Elle offre des fonctions pour gérer les annonces de type bannière
et vidéo récompense.
2. Les méthodes publiques
2.1 AdmobManager
AdmobManager(sf::RenderWindow &window, ANativeActivity* activity, JNIEnv* env, JavaVM* vm)
52
Code Source
Constructeur de la classe, elle prend en paramètre la fenêtre, l’activité Android et la machine virtuel.
2.2 loadBannerAd
void loadBannerAd()
Code Source
Lance une requête pour l’annonce de type bannière.
2.3 showBannerAd
void showBannerAd()
Code Source
Affiche une bannière d’annonce à condition que la requête ait été bien exécutée.
2.4 hideBannerAd
void hideBannerAd()
Code Source
Cache la bannière d’annonce.
2.5 loadRewardVideo
void loadRewardVideo()
Code Source
Lance une requête pour l’annonce de type vidéo récompense.
2.6 updateSFMLApp
auto updateSFMLApp(bool whiteColor)
Code Source
Met à jour l’application SFML en arrière-plan lorsqu’une annonce est affichée. Ceci permet d’eviter le plantage du
programme principal.
2.7 checkAdObjInit
void checkAdObjInit()
Code Source
Assure l’initialisation des composants d’Admob.
2.8 checkAdRewardObjReinitialize
void checkAdRewardObjReinitialize()
Code Source
Rénitialise les composants d’Admob.
3. Autres Fonction d’AdmobManager
3.1 ProcessEvents & WaitForFutureCompletion
53
static bool ProcessEvents(int msec)
static void WaitForFutureCompletion(firebase::FutureBase future)
Code Source
Assure le bon fonctionnement des tests sur les composants d’annonces.
3.2 checkAdState
static bool checkAdState(firebase::FutureBase future)
Code Source
Retourne vrais si le test sur le composant d’annonce a été bien effectué, faux si non.
Temps
1. class GameTime
class GameTime;
Entête : isEngine/system/function/GameTime.h
Code Source
Cette Classe permet de manipuler le temps du jeu (le chronomètre). Très utilise pour les jeux de plateforme style Super
Mario Bros ou Sonic qui utilise un chronomètre dans un niveau.
2. Les methods publiques de GameTime
2.1 GameTime
Première forme
GameTime()
Code Source
Constructeur par défaut, initialise tous les compteurs (minute, seconde, milliseconde) à zéro (0).
Deuxième forme
GameTime(unsigned int ms)
Code Source
Constructeur pour initialiser le temps avec les millisecondes qui seront distribuées plus tard en minutes et secondes.
Troisième forme
GameTime(unsigned int m, unsigned int s, unsigned int ms = 0)
Code Source
Constructeur pour initialiser le temps avec les minutes, secondes et millisecondes.
2.2 step
void step(float const &DELTA_TIME, float const &VALUE_CONVERSION, float const &VALUE_TIME)
Code Source
54
Lancer le compte à rebours du chronomètre pour qu'il s'arrête à zéro (0).
2.3 addTimeValue
void addTimeValue(int m, int s = 0, int ms = 0)
Code Source
Ajouter les minutes, les secondes et les millisecondes au temps actuel.
2.4 setTimeValue
void setTimeValue(int m, int s = 0, int ms = 0)
Code Source
Définie une nouvelle minute, seconde et milliseconde pour le temps actuelle.
2.5 setMSecond
void setMSecond(int ms)
Code Source
Définie des millisecondes qui seront distribuées en minutes et secondes.
2.6 getTimeString
std::string getTimeString() const
Code Source
Retourne le temps actuel sous la forme d'une chaîne de caractère (exemple 00: 00.00).
2.7 getTimeValue
unsigned int getTimeValue() const
Code Source
Retourne le temps en milliseconde.
2.8 getMinute
unsigned int getMinute() const
Code Source
Retourne la minute.
2.9 getSecond
unsigned int getSecond() const
Code Source
Retourne la seconde.
2.10 getMSecond
unsigned int getMSecond() const
Code Source
55
Retourne la milliseconde.
2.11 compareTime
bool compareTime(unsigned int m, unsigned int s = 0, unsigned int ms = 0) const
Code Source
Compare le temps renseigné et le temps de l'objet.
Retourne vrai si le temps renseigné est supérieur au temps de l'objet faux sinon.
2.12 operator=
GameTime& operator=(GameTime const &t)
Code Source
Opérateur d’égalité pour comparer deux objets de type temps.
2.13 operator<<
friend std::ostream& operator<<(std::ostream &flux, GameTime const &t)
Code Source
Operateur pour afficher le temps avec le flux std::cout.
3. Autres Fonctions de GameTime
bool operator==(GameTime const &t1, GameTime const &t2)
bool operator>(GameTime const &t1, GameTime const &t2)
bool operator<(GameTime const &t1, GameTime const &t2)
Code Source
Ces Opérateurs permettent de faire des comparaisons avec les objets de type temps.
Commande du jeu
1. class GameKeyData
class GameKeyData
Entête : isEngine/system/function/GameKeyData.h
Code Source
Classe qui permet de gérer les commandes du jeu. Elle prend en compte le clavier et la souris sur PC et devient un Game
Pad Virtuel sur Android.
2. Les éléments de GameKeyData
2.1 enum VirtualKeyIndex
enum VirtualKeyIndex;
Enumérateur
V_KEY_LEFT
Représente la touche directionnelle GAUCHE
56
V_KEY_RIGHT
Représente la touche directionnelle DROITE
V_KEY_UP
Représente la touche directionnelle HAUT
V_KEY_DOWN
Représente la touche directionnelle BAS
V_KEY_A
Représente la touche A
V_KEY_B
Représente la touche B
V_KEY_NONE
Aucune touche
Code Source
Repérsente les commandes du jeu.
2.2 GameKeyData
GameKeyData(is::GameDisplay *scene)
Code Source
Constructeur qui prend en paramètre la scène.
2.3 loadResources
void loadResources(sf::Texture &tex)
Code Source
Permet de charger la texture qui servira à créer les touches du Game Pad Virtuel.
2.4 step
void step(float const &DELTA_TIME)
Code Source
Met à jour la position du Game Pad Virtuel sur l’écran et permet aussi de détecter l’utilisation des commandes.
2.5 draw
void draw(sf::RenderTexture &surface)
Code Source
Affiche le Game Pad Virtuel.
2.6 m_keyPausePressed
bool m_keyPausePressed
Code Source
Détermine si la touche de pause est appuyée.
2.7 m_keyLeftPressed
bool m_keyLeftPressed
Code Source
Stock l’état de la touche GAUCHE.
2.8 m_keyRightPressed
bool m_keyRightPressed
57
Code Source
Stock l’état de la touche DROITE.
2.9 m_keyUpPressed
bool m_keyUpPressed
Code Source
Stock l’état de la touche HAUT.
2.10 m_keyDownPressed
bool m_keyDownPressed
Code Source
Stock l’état de la touche BAS.
2.11 m_keyAPressed
bool m_keyAPressed
Code Source
Stock l’état de la touche A.
2.12 m_keyBPressed
bool m_keyBPressed
Code Source
Stock l’état de la touche B.
2.13 m_keyAUsed
bool m_keyAUsed
Code Source
Stock l’état de la touche A quand elle est utilisée.
2.14 m_keyBUsed
bool m_keyBUsed
Code Source
Stock l’état de la touche B quand elle est utilisée.
2.15 m_keyLeftUsed
bool m_keyLeftUsed
Code Source
Stock l’état de la touche GAUCHE quand elle est utilisée.
2.16 m_keyRightUsed
bool m_keyRightUsed
58
Code Source
Stock l’état de la touche DROITE quand elle est utilisée.
2.17 m_keyUpUsed
bool m_keyUpUsed
Code Source
Stock l’état de la touche HAUT quand elle est utilisée.
2.18 m_keyDownUsed
bool m_keyDownUsed
Code Source
Stock l’état de la touche BAS quand elle est utilisée.
2.19 m_disableAllKey
bool m_disableAllKey
Code Source
Permet de désactiver tous les commandes du jeu.
2.20 m_hideGamePad
bool m_hideGamePad
Code Source
Permet de cacher le Game Pad Virtuel sur Android.
2.21 m_keyboardA
sf::Keyboard::Key m_keyboardA
Code Source
Représente la touche du clavier qui sert de touche A.
2.22 m_keyboardB
sf::Keyboard::Key m_keyboardB
Code Source
Représente la touche du clavier qui sert de touche B.
2.23 m_keyboardLeft
sf::Keyboard::Key m_keyboardLeft
Code Source
Représente la touche du clavier qui sert de touche GAUCHE.
2.24 m_keyboardRight
sf::Keyboard::Key m_keyboardRight
59
Code Source
Représente la touche du clavier qui sert de touche DROITE.
2.25 m_keyboardUp
sf::Keyboard::Key m_keyboardUp
Code Source
Représente la touche du clavier qui sert de touche HAUT.
2.26 m_keyboardDown
sf::Keyboard::Key m_keyboardDown
Code Source
Représente la touche du clavier qui sert de touche BAS.
2.27 m_moveKeyPressed
VirtualKeyIndex m_moveKeyPressed
Code Source
Permet de savoir si les touches directionnelles virtuelles sont appuyées.
2.28 m_actionKeyPressed
VirtualKeyIndex m_actionKeyPressed
Code Source
Permet de savoir si les touches virtuelles A, B sont appuyées.
2.29 keyLeftPressed
bool keyLeftPressed()
Code Source
Retourne vrai si la touche directionnelle GAUCHE est appuyée, faux si non.
2.30 keyRightPressed
bool keyRightPressed()
Code Source
Retourne vrai si la touche directionnelle DROITE est appuyée, faux si non.
2.31 keyUpPressed
bool keyUpPressed()
Code Source
Retourne vrai si la touche directionnelle HAUT est appuyée, faux si non.
2.32 keyDownPressed
bool keyDownPressed()
60
Code Source
Retourne vrai si la touche directionnelle BAS est appuyée, faux si non.
2.33 keyAPressed
bool keyAPressed()
Code Source
Retourne vrai si la touche A est appuyée, faux si non.
2.34 keyBPressed
bool keyBPressed()
Code Source
Retourne vrai si la touche B est appuyée, faux si non.
2.35 virtualKeyPressed
bool virtualKeyPressed(VirtualKeyIndex virtualKeyIndex)
Code Source
Retourne vrai si la touche virtuelle correspondante est appuyée, faux si non.
3. Autres fonctions de GameKeyData
Ces fonctions se trouvent dans GameKeyName.h.
Entête : isEngine/system/function/GameKeyName.h
Première forme
inline const char *getKeyName(const sf::Keyboard::Key key)
Code Source
Retourne le nom de la touche du clavier sous forme de chaine de caractèère.
Deuxième forme
inline std::wstring getKeyWName(const sf::Keyboard::Key key)
Code Source
Retourne le nom de la touche du clavier sous forme de chaine std::wstring.
Game Système
1. class GameSystem
class GameSystem;
Entête : isEngine/system/function/GameSystem.h
Code Source
61
Classe de base qui permet d’assurer le partage des informations du jeu entre les différents composants du moteur de
jeu. Elle contient les variables globales et fonctions qui assurent le bon fonctionnement du moteur.
2. Les éléments de GameSystem
2.1 enum ValidationButton
enum ValidationButton;
Enémerateur
MOUSE
Représente le bouton de validation de la souris (s'il est utilisé, il devient une action tactile sur
Android)
KEYBOARD
Représente le bouton de validation du clavier
ALL_BUTTONS
Représente le bouton de validation de la souris et du clavier (s'il est utilisé, il devient une
action tactile sur Android)
Code Source
Représenter la touche de validation sur PC, Il permet de connaitre le bouton qui sera utilisé lors d’un test de validation.
2.2 GameSystem
GameSystem()
Code Source
Constructeur par défaut.
2.3 isPressed
bool isPressed(
#if defined(__ANDROID__)
int finger = 0
#else
ValidationButton validationButton = ALL_BUTTONS
#endif
) const
Code Source
Windows, Linux:
Vérifie si la touche de validation est appuyée.
La touche de validation est définie dans GameConfig.h (voir ici : 3.1).
Android :
Vérifie si l'écran est touché par l'utilisateur.
Paramètre :
finger index du doigt (sur Android).
validationButton Représente le bouton de validation à utiliser pour passer le test.
Exemple :
62
Vérifier si la touché de validation du clavier est appuiée, Par défaut cette touche est ENTER.
if (m_gameSystem.isPressed(is::GameSystem::ValidationButton::KEYBOARD))
{
// do something
}
Vérifier si le bouton de validation de la souris est appuié, Par défaut c’est le bouton GAUCHE.
if (m_gameSystem.isPressed(is::GameSystem::ValidationButton::MOUSE)
{
// do something
}
2.4 keyIsPressed
Première forme
bool keyIsPressed(sf::Keyboard::Key key) const
Code Source
Vérifiez si la touche du clavier est enfoncée.
Retourne vrais si la touche est enfoncée, faux sinon.
Deuxième forme
bool keyIsPressed(sf::Mouse::Button button) const
Code Source
Vérifiez si le bouton de la souris est enfoncé.
Retourne vrais si le bouton est enfoncé, faux sinon.
2.5 fileExist
bool fileExist(std::string const &fileName) const
Code Source
Retourne vrai si le fichier existe, faux si non.
2.6 playSound
void playSound(sf::Sound &obj)
Code Source
Permet de jouer un son si l'option est activée.
2.7 playMusic
void playMusic(sf::Music &obj)
Code Source
Permet de jouer une musique si l'option est activée.
2.8 stopSound
void stopSound(sf::Sound &obj)
63
Code Source
Permet de stopper un son.
2.9 stopMusic
void stopSound(sf::Music &obj)
Code Source
Permet de stopper une musique.
2.10 useVibrate
void useVibrate(short ms)
Code Source
Permet d'utiliser le vibreur si l'option est activée (uniquement pour Android).
Paramètre ms représente la durée du vibreur en milliseconde.
2.11 saveConfig
void saveConfig(std::string const &fileName)
Code Source
Sauvegarde les données de configurations du jeu.
2.12 loadConfig
void loadConfig(std::string const &fileName)
Code Source
Charge les données de configurations du jeu.
2.13 savePadConfig
void savePadConfig(std::string const &fileName)
Code Source
Enregistre les données de configuration du Game Pad Virtuel.
2.14 loadPadConfig
void loadPadConfig(std::string const &fileName)
Code Source
Charge les données de configuration du Game Pad Virtuel.
2.15 m_disableKey
bool m_disableKey
Code Source
S’il est vrai toutes les fonctions du moteur qui gèrent les entrées (clavier, souris, tactile) sont désactivées.
2.16 m_enableSound
64
bool m_enableSound
Code Source
Permet de savoir si le son est activé.
2.17 m_enableMusic
bool m_enableMusic
Code Source
Permet de savoir si la musique est activée.
2.18 m_enableVibrate
bool m_enableVibrate
Code Source
Permet de savoir si le vibreur est activé.
2.19 m_keyIsPressed
bool m_keyIsPressed
Code Source
Permet de savoir si une touche / un bouton a été enfoncée.
2.20 m_firstLaunch
bool m_firstLaunch
Code Source
Permet de vérifier si le jeu a été lancé au moins une fois.
2.21 m_validationMouseKey
sf::Mouse::Button m_validationMouseKey
Code Source
Représente la variable qui stocke le boutton de validation de la souris.
2.22 m_validationKeyboardKey
sf::Keyboard::Key m_validationKeyboardKey
Code Source
Représente la variable qui stocke la touche de validation du clavier.
2.23 m_gameLanguage
int m_gameLanguage
Code Source
Représente l'index de la langue choisie.
2.24 m_padAlpha
65
int m_padAlpha
Code Source
Permet de modifier la transparence du Game Pad Virtuel.
Game System Extended
1. class GameSystemExtended
class GameSystemExtended;
Entête : app_src/gamesystem_ext/GameSystemExtended.h
Code Source
Classe dérivée de GameSystem (cliquer ici 1 pour plus d’info), elle assure le même rôle que son parent. Sa
particularité est qu’elle contient de nouveaux éléments qui serviront à gérer le game play et à manipuler les différentes
scènes de jeu.
2. Les éléments de GameSystemExtended
2.1 GameSystemExtended
GameSystemExtended()
Code Source
Constructeur par défaut.
2.2 initSystemData
void initSystemData()
Code Source
Initialise les données liées au moteur de jeu.
2.3 initProgress
void initProgress()
Code Source
Initialise les données de progression du jeu.
2.4 initData
void initData(bool clearCurrentLevel = true)
Code Source
Initialise les données de game play (score, vie, …).
2.5 saveData
void saveData(std::string const &fileName)
Code Source
Sauvagarde les données du jeu.
66
2.6 loadData
void loadData(std::string const &fileName)
Code Source
Charge les données du jeu.
2.7 m_launchOption
DisplayOption m_launchOption
Code Source
Détermine l’action (cliquer ici 1 pour voir les actions) qui sera effectuée sur les différentes scènes du jeu.
2.8 game play variables
int m_gameProgression
int m_levelNumber
int m_currentLevel
int m_currentLives
int m_currentBonus
int m_currentScore
int m_levelTime
Code Source
Les variables globales du jeu.
Game Function
Entête : isEngine/system/function/GameFunction.h
Ces fonctions du moteur permettent de faire des conversions sur les chaines de caractères, manipuler le temps,
manipuler les objets SFML, afficher des texts spéciaux, utiliser certaines fonctionnaltés d’Android, faire des calculs
géométriques, faire des tests sur des variables, utiliser des fonctions pour manipuler des valeurs aléatoires, …
1. Fonction Générale
1.1 VALUE_CONVERSION
static float const VALUE_CONVERSION(65.f);
Code Source
Agit sur le timing des compteurs.
Exemple:
Ceci créer un compteur en milliseconde quand on le met dans la boucle de mise à jour
// msCpt est une variable de type entier
msCpt += (is::VALUE_CONVERSION * 1.538f) * DELTA_TIME; // DELTA_TIME est le temps d’éxécution renvoyé par la
machine
1.2 WITH
#define WITH(_SIZE)
67
Code Source
Permet de parcourir un tableau de vector. _I est le compteur.
Exemple:
WITH(vectoreArray.size())
{
vectoreArray[_I]->function(…);
}
1.3 w_chart_tToStr
std::string w_chart_tToStr(wchar_t const *str)
Code Source
Convertie un w_chart_t en std::string.
1.4 strToWStr
std::wstring strToWStr(const std::string &str)
Code Source
Convertie un std::string en std::wstring.
1.5 numToStr
template <class T>
std::string numToStr(T val)
Code Source
Convertie un numérique en un std::string.
1.6 strToNum
template <typename T>
T strToNum(const std::string &str)
Code Source
Convertie un std::string en un numérique.
1.7 numToWStr
template <class T>
std::wstring numToWStr(T val)
Code Source
Convertie un numérique en un std::wstring.
1.8 writeZero
template <class T>
std::string writeZero(T val, int zeroNumber = 1)
68
Code Source
Dessine des zeros devant un nombre.
Paramètre zeroNumber représente le nombre de zéro à afficher.
Exemple :
int var(7);
std::cout << is::writeZero(var, 2) << std::endl; // sa affiche dans la console “007”
1.9 getMSecond
int getMSecond(float const &DELTA_TIME)
Code Source
Retourne le temps d’exécution en milliseconde.
1.10 showLog
void showLog(std::string str, bool stopApplication = false)
Code Source
Affiche des messages dans la console. Si stopApplication est vrai il arrête l’application.
1.11 arraySize
template <size_t SIZE, class T>
inline size_t arraySize(T (&arr)[SIZE])
Code Source
Retourne la taille d’un tableau.
1.12 choose
template <typename T>
T choose(unsigned short valNumber, T x1, T x2, T x3 = 0, T x4 = 0, T x5 = 0, T x6 = 0, T x7 = 0, T x8 = 0, T x9 = 0)
Code Source
Permet de faire le choix d’une valeur de façon aléatoire.
Paramètre valNumber le nombre valeur à tester.
Exemple :
std::cout << is:: choose(3, 7, 12, 4) << std::endl; // sa affiche dans la console de façon aléatoire 7 ou 12 ou 4
1.13 setVarLimit
template <typename T>
void setVarLimit(T &var, T valMin, T valMax)
69
Code Source
Permet d’encadrer une valeur.
1.14 isIn
bool isIn(unsigned short valNumber, int const var, int x1, int x2, int x3 = 0, int x4 = 0, int x5 = 0, int x6 = 0, int x7 = 0, int
x8 = 0, int x9 = 0)
Code Source
Vérifie si la valeur d’une variable se trouve dans un ensemble de valeur.
Exemple :
int year(2020);
if (is::isIn(3, year, 2020, 2005, 2000)) // cette condition sera vraie car la valeur de year ce trouve dans la fonction
{
// do something
}
1.15 isBetween
bool isBetween(float a, float b, float c)
Code Source
Vérifies si une valeur se trouve dans un intervalle.
1.16 isCrossing
bool isCrossing(float l1, float r1, float l2, float r2)
Code Source
Vérifie si un point intersecte un autre.
1.17 side
int side(Point m, Point a,Point b)
Code Source
Retourne -1 à gauche, 1 à droite, 0 si a b c sont alignés.
1.18 sign
int sign(float x)
Code Source
Retourne le signe de la valeur.
1.19 pointDirection
template <typename T>
T pointDirection(float x1, float y1, float x2, float y2)
Code Source
Determine l’angle entre deux points.
70
1.20 pointDistance
float pointDistance(float x1, float y1, float x2, float y2)
Code Source
Determine la distance entre deux points.
1.21 radToDeg
float radToDeg(float x)
Code Source
Convertie le radient en dégrée.
1.22 degToRad
float degToRad(float x)
Code Source
Convertie le dégrée en radiant.
1.23 lengthDirX
float lengthDirX(float dir, float angle)
Code Source
Retourne la composante de x.
1.24 lengthDirY
float lengthDirY(float dir, float angle)
Code Source
Retourne la composante de y.
1.25 increaseVar
template <typename T>
void increaseVar(const float &DELTA_TIME, T &var, T increaseValue, T varFinal, T varMax)
Code Source
Incrémente une variable avec le temps d’éxécution.
Exemple :
int var(0);
is::increaseVar(DELTA_TIME, var, 1, 15, 10)); // la variable “var” va s’incrémenter avec la valeur 1. Si elle est
// suppérieur à 10 elle devient 15 et l’incrémentation s’arrête
1.26 decreaseVar
template <typename T>
void decreaseVar(const float &DELTA_TIME, T &var, T decreaseValue, T varFinal = 0, T varMin = 0)
71
Code Source
Décrémente une variable avec le temps d’éxécution.
Exemple :
int var(40);
is::decreaseVar(DELTA_TIME, var, 1, 20, 25)); // la variable “var” va se décrémenter avec la valeur 1. Si elle est
// inférieur à 25 elle devient 20 et la décrémentation s’arrête
1.27 collisionTest
bool collisionTest(Rectangle const &a, Rectangle const &b)
bool collisionTest(Circle const &a, Circle const &b)
bool collisionTest(Circle const &circle, Rectangle const &rec)
bool collisionTest(Rectangle const &rec, Circle const &circle)
Code Source
Test la collision entre le masque de collision Rectange et Cercle.
2. Fonction sur les objets SFML
2.1 getSFMLObjAngle
template <class T>
float getSFMLObjAngle(T obj)
Code Source
Retourne l’angle de l’objet.
2.2 getSFMLObjXScale
template <class T>
float getSFMLObjXScale(T obj)
Code Source
Retourne l’échelle x de l’objet.
2.3 getSFMLObjYScale
template <class T>
float getSFMLObjYScale(T obj)
Code Source
Retourne l’échelle y de l’objet.
2.4 getSFMLObjWidth
template <class T>
float getSFMLObjWidth(T obj)
Code Source
72
Retourne la largeur de l’objet.
2.5 getSFMLObjHeight
template <class T>
float getSFMLObjHeight(T obj)
Code Source
Retourne la hauteur de l’objet.
2.6 getSFMLObjOriginX
template <class T>
float getSFMLObjOriginX(T obj)
Code Source
Retourne l’origine en x.
2.7 getSFMLObjOriginY
template <class T>
float getSFMLObjOriginY(T obj)
Code Source
Retourne l’origine en y.
2.8 getSFMLObjX
Première forme
template <class T>
float getSFMLObjX(T obj)
Deuxième forme
template <class T>
float getSFMLObjX(T *obj)
Code Source
Retourne la position x.
2.9 getSFMLObjY
Première forme
template <class T>
float getSFMLObjY(T obj)
Deuxième forme
template <class T>
float getSFMLObjY(T *obj)
73
Code Source
Retourne la position y.
2.10 setSFMLObjAngle
template <class T>
void setSFMLObjAngle(T &obj, float angle)
Code Source
Définie l’angle.
2.11 setSFMLObjRotate
template <class T>
void setSFMLObjRotate(T &obj, float rotationSpeed)
Code Source
Définie la rotation de l’objet.
2.12 setSFMLObjScaleX_Y
template <class T>
void setSFMLObjScaleX_Y(T &obj, float x, float y)
Code Source
Définie l’échelle x et y.
2.13 setSFMLObjScale
template <class T>
void setSFMLObjScale(T &obj, float scale)
Code Source
Définie l’échelle x et y avec la même valeur.
2.14 setSFMLObjOrigin
template <class T>
void setSFMLObjOrigin(T &obj, float x, float y)
Code Source
Définie l’origine x et y.
2.15 setSFMLObjX
template <class T>
void setSFMLObjX(T &obj, float x)
Code Source
Définie la position x.
74
2.16 setSFMLObjY
template <class T>
void setSFMLObjY(T &obj, float y)
Code Source
Définie la position y.
2.17 centerSFMLObj
template <class T>
void centerSFMLObj(T &obj)
Code Source
Centrer l’objet en x et y.
2.18 centerSFMLObjX
template <class T>
void centerSFMLObjX(T &obj)
Code Source
Centrer l’objet en x.
2.19 centerSFMLObjY
template <class T>
void centerSFMLObjY(T &obj)
Code Source
Centrer l’objet en y.
2.20 setSFMLObjX_Y
Première forme
template <class T>
void setSFMLObjX_Y(T &obj, sf::Vector2f position)
Deuxième forme
template <class T>
void setSFMLObjX_Y(T &obj, float x, float y)
Code Source
Définie la position x et y.
2.21 moveSFMLObjX
template <class T>
void moveSFMLObjY(T &obj, float speed)
75
Code Source
Déplace l’objet SFML sur l’axe des x.
2.22 moveSFMLObjY
template <class T>
void moveSFMLObjY(T &obj, float speed)
Code Source
Déplace l’objet SFML sur l’axe des y.
2.23 setSFMLObjSize
Première forme
template <class T>
void setSFMLObjSize(T &obj, float x, float y)
Deuxième forme
template <class T>
void setSFMLObjSize(T &obj, sf::Vector2f v)
Code Source
Définie la taille de l’objet.
2.24 setSFMLObjAlpha
Première forme
template <class T>
void setSFMLObjAlpha(T &obj, unsigned int alpha)
Deuxième forme
template <class T>
void setSFMLObjAlpha(T &obj, unsigned int alpha, sf::Uint8 r, sf::Uint8 g, sf::Uint8 b)
Troisième forme
template <class T>
void setSFMLObjAlpha(T &obj, unsigned int alpha, sf::Uint8 rgb)
Code Source
Définie la transparence. Peut générer des WARNING si on l’utilise sur des textes et des formes géométriques !
2.25 setSFMLObjAlpha2
template <class T>
void setSFMLObjAlpha2(T &obj, unsigned int alpha)
Code Source
76
Définie la transparence pour les objets de type texte, rectangles, ...Ne marche pas sur les sprite !
2.26 setSFMLObjColor
template <class T>
void setSFMLObjColor(T &obj, sf::Color color)
Code Source
Définie la couleur de l’objet (Sprite).
2.27 setSFMLObjFillColor
template <class T>
void setSFMLObjFillColor(T &obj, sf::Color color)
Code Source
Définie la couleur de l’objet (Texte, Rectangle, ..).
2.28 scaleAnimation
template <class T>
void scaleAnimation(float const &DELTA_TIME, float &var, T &obj, short varSign = 1, float scaleSize = 1.f)
Code Source
Permet de faire une animation d’étirement sur un objet SFML.
2.29 setFrame
void setFrame(sf::Sprite &sprite, float frame, int subFrame, int frameSize = 32, int recWidth = 32, int recHeight = 32)
Code Source
Définie l’animation d’un sprite (cliquer ici Figure 1 pour voir comment on l’utilise).
2.30 setSFMLObjOutlineColor
Première forme
template <class T>
void setSFMLObjOutlineColor(T &obj, sf::Color color)
Code Source
Définie la couleur de contour.
Deuxième forme
template <class T>
void setSFMLObjOutlineColor(T &obj, float thickness, sf::Color color)
Code Source
Définie la couleur de contour et sa taille.
2.31 setSFMLObjTexRec
77
template <class T>
void setSFMLObjTexRec(T &obj, int x, int y, int w = 32, int h = 32)
Code Source
Définie le intRect.
2.32 setSFMLObjProperties
template <class T>
void setSFMLObjProperties(T &obj, float x, float y, float angle = 0.f, int alpha = 255, float xScale = 1.f, float yScale = 1.f)
Code Source
Définie les diverses propriétés d’un objet SFML.
2.33 loadSFMLObjResource
Première forme
template <class T>
bool loadSFMLObjResource(T &obj, std::string filePath, bool stopExecution = false)
Code Source
Permet de charger une ressource pour un object SFML (Texture, Sound Buffer, …).
Paramètre :
obj l’objet SFML.
filePath chemin du fichier ressource.
stopExecution permet d’arreter l’exécution du programme en cas d’erreur.
Retourne vrais si le fichier ressource a été bien chargé et faux si non.
Deuxième forme
template <class T>
inline bool loadSFMLObjResource(sf::SoundBuffer &sb, sf::Sound &snd, T &obj, std::string filePath, bool stopExecution
= false)
Code Source
Permet de charger un fichier ressource pour un Sound Buffer et de l’associer à un son.
2.34 getSFMLSndState
template <class T>
bool getSFMLSndState(T &obj, sf::Sound::Status state)
Code Source
Retourne l’état du son.
2.35 collisionTestSFML
78
template <class A, class B>
bool collisionTestSFML(A const &objA, B const &objB)
Code Source
Test la collision entre deux (2) objets SFML.
2.36 createRectangle
void createRectangle(sf::RectangleShape &rec, sf::Vector2f recSize, sf::Color color, float x = 0.f, float y = 0.f, bool center =
true)
Code Source
Créer un rectangle avec divers paramètres.
2.37 textStyleConfig
void textStyleConfig(sf::Text &txt, bool underLined, bool boldText, bool italicText)
Code Source
Définie le style d’un texte.
2.38 createWText
void createWText(sf::Font const& fnt, sf::Text &txt, std::wstring const &text, float x, float y, sf::Color color, int txtSize =
20, bool underLined = false, bool boldText = false, bool italicText = false)
Code Source
Créer un texte avec un chaine std::wstring.
2.39 createText
Première forme
void createText(sf::Font const& fnt, sf::Text &txt, std::string const &text, float x, float y, int txtSize = 20, bool
underLined = false, bool boldText = false, bool italicText = false)
Deuxième forme
void createText(sf::Font const& fnt, sf::Text &txt, std::string const &text, float x, float y, bool centerText, int txtSize =
20, bool underLined = false, bool boldText = false, bool italicText = false)
Troisième forme
void createText(sf::Font const& fnt, sf::Text &txt, std::string const &text, float x, float y, sf::Color color, int txtSize = 20,
bool underLined = false, bool boldText = false, bool italicText = false)
Quatrième forme
void createText(sf::Font const& fnt, sf::Text &txt, std::string const &text, float x, float y, sf::Color color, bool centerText,
int txtSize = 20, bool underLined = false, bool boldText = false, bool italicText = false)
Cinquième forme
void createText(sf::Font const& fnt, sf::Text &txt, std::string const &text, float x, float y, sf::Color color, sf::Color
outlineColor, int txtSize = 20, bool underLined = false, bool boldText = false, bool italicText = false)
Code Source
79
Ces fonctions permettent de créer un texte avec divers paramètres.
2.40 createSprite
Première forme
void createSprite(sf::Texture &tex, sf::Sprite &spr, sf::Vector2f position, sf::Vector2f origin, bool smooth = true)
Deuxième forme
void createSprite(sf::Texture &tex, sf::Sprite &spr, sf::IntRect rec, sf::Vector2f position, sf::Vector2f origin, bool
repeatTexture = false, bool smooth = true)
Troisième forme
void createSprite(sf::Texture &tex, sf::Sprite &spr, sf::IntRect rec, sf::Vector2f position, sf::Vector2f origin, sf::Vector2f
scale, unsigned int alpha = 255, bool repeatTexture = false, bool smooth = true)
Code Source
Ces fonctions permettent de créer un sprite avec divers paramètres.
2.41 mouseCollision
Première forme
template <class T>
bool mouseCollision(sf::RenderWindow &window, T const &obj
#if defined(__ANDROID__)
, unsigned int finger = 0
#endif
)
Code Source
Windows, Linux : Détecte si le curseur de la souris est en collision avec un objet de la fenêtre.
Android : Détecte si l’utilisateur touche un objet de la fenêtre.
Paramètre :
obj l’objet avec lequel on veut faire le test.
finger représente l’index du doigt.
Retourne vrais si il y a collision et faux si non.
Exemple :
if (mouseCollision(window, sprite))
{
// do something
}
Deuxième forme
template <class T>
80
bool mouseCollision(sf::RenderWindow &window, T const &obj, sf::RectangleShape &cursor
#if defined(__ANDROID__)
, unsigned int finger = 0
#endif
)
Code Source
Windows, Linux : Détecte si le curseur de la souris est en collision avec un objet de la fenêtre.
Android : Détecte si l’utilisateur touche un objet de la fenêtre.
Paramètre :
obj l’objet avec lequel on veut faire le test.
cursor permet de récupérer la position du point de collision.
finger représente l’index du doigt.
Retourne vrais si il y a collision et faux si non.
Exemple :
sf::ReactangleShape rec;
if (mouseCollision(window, sprite, rec))
{
float cursorXPosition = rec.getPosition.x();
float cursorYPosition = rec.getPosition.y();
}
3. Autres fonctions
3.1 vibrate
int vibrate(sf::Time duration)
Code Source
Lance le vibreur Android.
3.2 openURL
void openURL(std::string urlStr)
Code Source
Ouvre un url dans le navigateur (e.g www.website.com).
3.3 setScreenLock
void setScreenLock(bool disableLock)
Code Source
Définie le verrouillage de l’écran Android.
3.4 jstring2string
81
static std::string jstring2string(JNIEnv *env, jstring jStr)
Code Source
Convertie jstring en std::string.
3.5 getDeviceId
static std::string getDeviceId(JNIEnv *env, ANativeActivity *activity)
Code Source
Retourne l’id du périphérique Android.
Bibliothèque externe
1. Swoosh
Elle est intégrée par défaut au moteur. C’est grace à elle que le moteur arrive à faire des effets transisitions.
Pour plus d’information cliquer ici.
2. Tiny File Dialogs (uniquement pour Windows et Linux)
2.1 class TinyDialogBox
class TinyDialogBox;
Entête : isEngine/ext_lib/TinyFileDialogs/TinyDialogsBox.h
Code Source
Classe qui permet d’utiliser la bibliothèque TinyFileDialogs de la façon la plus simple. Elle vous permet d’utiliser les
boites de dialogue du système d’exploitation (Windows et Linux).
2.2 tinyString
#if !defined(SFML_SYSTEM_LINUX)
typedef wchar_t const* tinyString;
#else
typedef char const* tinyString;
#endif
Code Source
Type personnalisé qui permet de manipuler les données de tinyFileDialogs. Lorsqu’on utilise tinyFileDialogs les
données diffèrent en fonction du système d’exploitation. Sur windows les chaines de caractères deviennent des wchar_t
const* et sur Linux des char const*, ce qui implique l’utilisation de deux (2) types differents ayant le même but pour un
même programme. Le type tinyString permet de palier à ce problème en déterminant automatiquement le type qui
correspond au système d’exploitation cible.
2.3 TINY_FILE_DIALOGBOX_PATH
static tinyString TINY_FILE_DIALOGBOX_PATH;
Code Source
82
Stocke le chemin du fichier de la boite de dialogue.
2.4 enum FileDialogType
enum FileDialogType;
Enumérateur
SAVE_FILE
Sauvegarde fichier
LOAD_FILE
Charger fichier
Code Source
Représente le type de boite de dialogue à afficher.
2.5 enum DialogType
enum DialogType;
Enumérateur
OK
Message avec bouton OK
OKCANCEL
Message avec bouton OK et CANCEL
YESNO
Message avec bouton YES et NO
Code Source
Représente les boutons qui seront affichés sur la boite de dialogue.
2.6 enum IconType
enum IconType;
Enumérateur
INFO
Boite de dialogue avec une icône INFO
WARNING
Boite de dialogue avec une icône WARNING
ERROR_ICO
Boite de dialogue avec une icône ERROR
QUESTION
Boite de dialogue avec une icône QUESTION
Code Source
Représente l’icône qui sera affichée sur la boite de dialogue.
2.7 enumDialogTypeToStr / enumIconTypeToStr
static tinyString const enumDialogTypeToStr(DialogType val)
static tinyString const enumIconTypeToStr(IconType val)
Code Source
Ces fonctions convertissent les enum en chaine de caractère pour les passés plus tard dans les fonctions de la
bibliothèque.
2.8 showDialogBox
static int showDialogBox(std::string title,
std::string msg,
DialogType dialogType,
83
IconType iconType
)
Code Source
Affiche une boite de dialogue de type message.
Retourne 1 lorsque l'utilisateur clique sur le bouton OK et 0 lorsqu’il clique sur CANCEL ou NO.
2.9 showFileDialogBox
static std::string showFileDialogBox(FileDialogType type,
std::string title,
tinyString filterPatterns[],
std::string fileName = "file",
std::string msgError = "Unable to access file!",
std::string errTitle = "Error"
)
Code Source
Affiche une boîte de dialogue de type fichier.
Retourne le chemin du fichier si la fonction a réussi et "" (chaîne vide) si non.
2.10 showFolderDialogBox
static std::string showFolderDialogBox(std::string title,
std::string defaultPath
#if !defined(SFML_SYSTEM_LINUX)
= L"C:\\",
#else
= L"/home/",
#endif
std::string msgError = "Unable to access folder!",
std::string errTitle = "Error"
)
Code Source
Affiche une boite de dialogue de type sélection dossier.
Retourne le chemin du dossier si la fonction a réussi et "" (chaîne vide) si non.
3. Box 2D
84
Box 2D est un moteur physique integer au moteur de jeu. Pour l’utiliser dans une scène vous devez l’inclure de cette
façon : #include "../../../isEngine/ext_lib/Box2D/Box2D.h"
Game Engine
1. class GameEngine
class GameEngine;
Entête : isEngine/core/GameEngine.h
Code Source
Cette Classe assure l’interconnexion des différents composants du moteur et lance la boucle de rendu dans laquelle le
jeu va se dérouler.
2. Les méthodes de GameEngine
2.1 GameEngine
GameEngine()
Code Source
Constructeur par défaut.
2.2 initEngine
bool initEngine()
Code Source
Initialise le moteur de jeu.
2.3 play
bool play()
Code Source
Boucle de rendu principal du moteur.
2.4 basicSFMLmain
bool basicSFMLmain()
Code Source
Boucle de rendu d’une fenêtre SFML classique.
2.5 getRenderWindow
sf::RenderWindow& getRenderWindow()
Code Source
Retourne la fenêtre SFML.
85
Configuration du jeu
namespace GameConfig;
Entête : app_src/config/GameConfig.h
Permet de définir des paramètres pour préconfigurer ces parties du jeu : La taille de la fenêtre et de la vue, Les touches
du clavier et de la souris à utiliser pour commander le jeu, les informations du jeu (nom, auteur, version), chemin des
fichiers ressources (son, image, sauvegarde, …) et les informations d’Admob.
1. enum DisplayOption
enum DisplayOption;
Enumérateur
RESUME_GAME
Quand le joueur ferme le menu pause
GAME_OPTION_RESTART
Recommence la scène avec l’option restart
QUIT_GAME
Quand le joueur utilise l’option quitter
INTRO
Accède à la scène d'introduction
RESTART_LEVEL
Recommence la scène quand on perd
NEXT_LEVEL
Aller au niveau suivant
MAIN_MENU
Accède à la scène Menu Principal
GAME_LEVEL
Accède à la scène Game Level
GAME_OVER
Accède à la scène Game Over
GAME_END_SCREEN
Accède à la scène Fin du jeu
Code Source
Permet de manipuler les différentes scènes et le menu pause du jeu.
2. Paramètre de la fenêtre
2.1 WINDOW_WIDTH
static const unsigned int WINDOW_WIDTH
Code Source
Définie la largeur de la fenêtre.
2.2 WINDOW_HEIGHT
static const unsigned int WINDOW_HEIGHT
Code Source
Définie la hauteur de la fenêtre.
2.3 VIEW_WIDTH
static const float VIEW_WIDTH
Code Source
Définie la largeur de la vue.
2.4 VIEW_HEIGHT
static const float VIEW_HEIGHT
Code Source
86
Définie la hauteur de la vue.
2.5 FPS
static const float FPS
Code Source
Définie le FPS (Frame Per Second) du jeu.
2.6 WINDOW_SETTINGS
static const is::WindowStyle WINDOW_SETTINGS
Code Source
Définie le style de la fenêtre.
3. Paramètre des boutons de validation
3.1 KEY_VALIDATION_MOUSE
static const sf::Mouse::Button KEY_VALIDATION_MOUSE
Code Source
Représente le bouton qui valide les options avec la souris.
3.2 KEY_VALIDATION_KEYBOARD
static const sf::Keyboard::Key KEY_VALIDATION_KEYBOARD
Code Source
Représente la touche qui valide les options avec le clavier.
3.3 KEY_CANCEL
static const sf::Keyboard::Key KEY_CANCEL
Code Source
Représente la touche qui annule les options avec le clavier.
4. Paramètre des touches du clavier
4.1 KEY_A
static const sf::Keyboard::Key KEY_A
Code Source
Représente la touche du bouton A.
4.2 KEY_B
static const sf::Keyboard::Key KEY_B
Code Source
Représente la touche du bouton B.
4.3 KEY_LEFT
static const sf::Keyboard::Key KEY_LEFT
87
Code Source
Représente la touche directionnelle GAUCHE.
4.4 KEY_RIGHT
static const sf::Keyboard::Key KEY_RIGHT
Code Source
Représente la touche directionnelle DROITE.
4.5 KEY_UP
static const sf::Keyboard::Key KEY_UP
Code Source
Représente la touche directionnelle HAUT.
4.6 KEY_DOWN
static const sf::Keyboard::Key KEY_DOWN
Code Source
Représente la touche directionnelle BAS.
5. Les informations du jeu
5.1 MAJOR
static const std::string MAJOR
Code Source
Définie la version majeur.
5.2 MINOR
static const std::string MINOR
Code Source
Définie la version mineur.
5.3 getGameVersion
inline std::string getGameVersion()
Code Source
Retourne la version du jeu.
5.4 GAME_NAME
static std::wstring const GAME_NAME
Code Source
Définie le nom du jeu.
5.5 GAME_AUTHOR
88
static std::wstring const GAME_AUTHOR
Code Source
Définie le nom de l’auteur.
6. Paramètre Admob
namespace AdmobConfig;
Permet de definir les informations d’Admob pour pouvoir afficher les annonces dans le jeu. Ces informations sont
fournies sur la plateforme de Google Admob !
6.1 Id de la PUB
6.1.1 kAdMobAppID
static const char* kAdMobAppID
Code Source
Code de l’application Admob.
6.1.2 kBannerAdUnit
static const char* kBannerAdUnit
Code Source
Code de la bannière.
6.1.3 kRewardedVideoAdUnit
static const char* kRewardedVideoAdUnit
Code Source
Code de la vidéo récompense.
6.2 Taille de la bannière de PUB
6.2.1 kBannerWidth
static const int kBannerWidth
Code Source
Définie la largeur de la bannière d’annonce.
6.2.2 kBannerHeight
static const int kBannerHeight
Code Source
Définie la hauteur de la bannière d’annonce.
6.3 Publique cible de la PUB
6.3.1 kBirthdayDay
static const int kBirthdayDay
Code Source
89
Définie le jour de naissance des utilisateurs.
6.3.2 kBirthdayMonth
static const int kBirthdayMonth
Code Source
Définie le mois de naissance des utilisateurs.
6.3.3 kBirthdayYear
static const int kBirthdayYear
Code Source
Définie l’année de naissance des utilisateurs.
6.3.4 kKeywords
static const char* kKeywords[]
Code Source
Mots-clés à utiliser pour faire la demande d’une annonce.
7. Chemin des fichiers ressources du jeu
7.1 GUI_DIR
static std::string const GUI_DIR
Code Source
Chemin des fichiers ressources qui servent d'interface graphique.
7.2 FONT_DIR
static std::string const FONT_DIR
Code Source
Chemin des fichiers ressources qui servent de police.
7.3 SPRITES_DIR
static std::string const SPRITES_DIR
Code Source
Chemin des fichiers ressources qui servent de Sprite.
7.4 TILES_DIR
static std::string const TILES_DIR
Code Source
Chemin des fichiers ressources qui servent de tuiles et d'arrière-plan.
7.5 SFX_DIR
static std::string const SFX_DIR
90
Code Source
Chemin des fichiers ressources qui servent de SFX.
7.6 MUSIC_DIR
static std::string const MUSIC_DIR
Code Source
Chemin des fichiers ressources qui servent de musique.
8. Nom du package du jeu (Android)
static std::string const PACKAGE_NAME
Code Source
Nom du package du jeu. Représente l'endroit où vos données seront enregistrées sur Android.
Vous devez appliquer ce nom pour l'applicationId dans le fichier build.gradle
9. Chemin des fichiers de sauvegarde
9.1 GAME_DATA_FILE
static std::string const GAME_DATA_FILE
Code Source
Chemin pour enregistrer le fichier de sauvegarde du jeu.
9.2 CONFIG_FILE
static std::string const CONFIG_FILE
Code Source
Chemin pour enregistrer le fichier de configuration du jeu.
9.3 GAME_PAD_FILE
static std::string const GAME_PAD_FILE
Code Source
Chemin pour enregistrer le fichier de configuration du Game Pad Virtuel sur Android.
Activité
1. class GameActivity
class GameActivity;
Entête : app_src/activity/GameActivity.h
Code Source
Permet de lancer les différentes scènes de jeu. Une autre particularité de cette classe est qu’elle relie les scènes du
moteur et la bibliothèque SWOOSH afin de pouvoir utiliser les effets transitions de cette dernière.
91
2. Les éléments de GameActivity;
2.1 GameActivity
GameActivity(ActivityController& controller, GameSystemExtended &gameSysExt)
Code Source
Constructeur de la classe, elle prend en paramètre le contrôleur d’activité (de la bibliothèque SWOOSH) et gestionnaire
du système de jeu (cliquer ici 1 pour plus d’info).
2.2 m_gameScene
std::shared_ptr<is::GameDisplay> m_gameScene;
Code Source
Instance de la scène qui sera utilisée.
2.3 onStart
virtual void onStart()
Code Source
Lorsque la scène est lancée.
2.4 onUpdate
virtual void onUpdate(double elapsed)
Code Source
Sert à mettre à jour les informations de la scène.
2.5 onLeave
virtual void onLeave()
Code Source
Lorsque la scène n’est plus utilisée (interruption).
2.6 onExit
virtual void onExit()
Code Source
Lorsqu’on quitte la scène pour une autre.
2.7 onEnter
virtual void onEnter()
Code Source
Lorsque la séquence de la scène commence.
2.8 onResume
virtual void onResume()
Code Source
92
Lorsqu’on reprend la scène après une interruption.
2.9 onDraw
virtual void onDraw(sf::RenderTexture& surface)
Code Source
Permet d’afficher la scène.
2.10 onEnd
virtual void onEnd()
Code Source
Lorsqu’on quitte la scène (destruction).
Niveau
1. Les niveaux
Dans is::Engine les niveaux du jeu sont des tableaux d’entier contenus dans des fichiers entête (fichier.h). Ces niveaux
sont créés grâce à l’éditeur de niveau is::Engine Level Editor (lien du projet) qui est livré avec le moteur.
Entête : app_src/levels/Level.h
2. Intégration d’un niveau
Pour intégrer un niveau on inclut son entête dans le fichier Level.h de cette façon :
#include "../levels/level_1.h"
3. Les éléments pour gérer les niveaux
3.1 namespace level
namespace level;
Code Source
Permet d’utiliser les contenus qui permettent de gérer les niveaux.
3.2 enum LevelId
enum LevelId
{
LEVEL_1,
LEVEL_2,
/* … */
, LEVEL_MAX // Permet de connaitre le nombre total de niveau intégré
}
Code Source
93
Représente l’index de chaque niveau. A chaque fois qu’un nouveau niveau est intégré au moteur on doit déclarer son
index.
3.3 getLevelMap
inline short const* getLevelMap(int CURRENT_LEVEL)
Code Source
Retourne le tableau du niveau renseigné dans le paramètre.
A chaque fois qu’un nouveau niveau est intégré, on doit renseigner l’instruction qui renverra ce niveau dans la fonction.
Exemple :
Intégration dans la fonction :
// Renvoie le tableau du niveau qui se trouve dans level_1.h
inline short const* getLevelMap(int CURRENT_LEVEL)
{
switch (CURRENT_LEVEL)
{
case LEVEL_1 : return LEVEL_1_MAP; break; // LEVEL_1_MAP est le nom du tableau qui se trouve dans level_1.h
// ...
Utilisation dans un fichier source externe : (Ceci est un exemple simple juste pour vous expliquer le
principe. Pour aller plus loin, veuillez-vous référer à la Démo du moteur)
short *currentLevelArray = getLevelMap(LEVEL_1); // Retourne le tableau qui se trouve dans level_1.h
Langage du jeu
1. Les langues
Les langues sont représentées dans is::Engine par des tableaux de chaine.
Entête : app_src/language/GameLanguage.h
2. Les éléments pour gérer les langues
2.1 namespace Lang
namespace lang;
Code Source
Sert à gérer les langues du jeu.
2.2 enum GameLanguage
enum GameLanguage
{
ENGLISH, ///< Représente la langue Anglaise
94
FRANCAIS, ///< Représente la langue le française
/* … */
}
Code Source
Cette énumération permet d’implémenter l’index de chaque langue afin de pourvoir les utilisées plus facilement lors du
développement.
Exemple:
Créer une phrase:
static std::string hello_world[] = { "Hello World !", "Salut le monde !" }; // A mettre dans GameLanguage.h
Utilisation : (Ceci est un exemple simple juste pour vous expliquer le principe. Pour aller plus loin,
veuillez-vous référer à la Démo du moteur)
gameSystemExt.m_gameLanguage = is::lang::GameLanguage::ENGLISH; // Choix de la langue Anglaise
is::showLog(is::lang::hello_world[gameSystemExt.m_gameLanguage]); // on aura dans la console : Hello World !
gameSystemExt.m_gameLanguage = is::lang::GameLanguage::FRANCAIS; // Choix de la langue Française
is::showLog(is::lang::hello_world[gameSystemExt.m_gameLanguage]); // on aura dans la console : Salut le monde !"
Boite de Dialogue du jeu
1. class GameDialog
class GameDialog;
Entête : app_src/objects/widgets/GameDialog.h
Code Source
Classe qui permet d’afficher des boites de dialogue comme dans les jeux RPG. Elle est étroitement liée à la partie langue
du jeu (cliquer ici 1 pour plus d’info). Pour pouvoir afficher une dialogue vous devez définir un tableau de chaine
représentant ce dialogue dans GameLanguage.h.
2. Les éléments de GameDialog
2.1 GameDialog
GameDialog(sf::Texture &tex, sf::Font &fnt, is::GameDisplay *scene)
Code Source
Constructeur de la classe, elle prend en paramètre la texture, la police et la scène dans laquelle elle est utilisée.
2.2 enum DialogIndex
enum DialogIndex
{
DIALOG_NONE = -1,
DIALOG_PLAYER_MOVE, // Représente le dialogue qui parle de comment déplacer le joueur
95
/* … */
};
Code Source
Représente les différents dialogues qui seront affichés dans le jeu. Les informations qui sont définies à l’intérieur sont
liées à la partie langue du jeu.
A chaque fois qu’un index est ajouté on doit déclarer son tableau de chaine dans GameLanguage.h.
Exemple :
Déclaration du dialogue DIALOG_PLAYER_MOVE dans GameLanguage.h :
static std::wstring dialog_player_move[] = {L"Press LEFT or RIGHT to move.\n"
"Press A to Jump.",
L"Appuie sur GAUCHE ou DROITE pour te déplacer.\n"
"Appuie sur A pour sauter."};
2.3 linkArrayToEnum
void linkArrayToEnum()
Code Source
Relie le tableau de chaine qui se trouve dans GameLanguage.h et l’index du dialogue.
Exemple :
Lier un Index et son tableau de chaine : (Ceci est un exemple simple juste pour vous expliquer le principe.
Pour aller plus loin, veuillez-vous référer à la Démo du moteur)
void linkArrayToEnum()
{
// …
switch (m_dialogIndex)
{
case DIALOG_PLAYER_MOVE: // l’index du dialogue
m_msgIndexMax = is::arraySize(is::lang::dialog_player_move); // Détermine le nombre de phrase
checkMsg(is::lang::dialog_player_move); // Définir le dialogue grâce à son tableau de chaine
break;
// …
2.4 step
void step(const float &DELTA_TIME)
Code Source
Met à jour les informations de la boite de dialogue.
96
2.5 setDialog
void setDialog(DialogIndex dialogIndex)
Code Source
Définie le dialogue qui sera lancé.
2.6 setMouseInCollison
void setMouseInCollison(bool val)
Code Source
Force la collision du curseur de la souris ou le doigt de l’utilisateur (sur Android) avec la boite de dialogue.
2.7 draw
void draw(sf::RenderTexture &surface)
Code Source
Affiche la boite de dialogue.
2.8 getDialogIndex
DialogIndex getDialogIndex() const
Code Source
Retourne l’enumérateur du dialogue qui est affiché.
2.9 getMouseInCollison
bool getMouseInCollison() const
Code Source
Retourne vrai quand le curseur de la souris ou le doigt de l’utilisateur (sur Android) touche la boite de dialogue, faux
si non.
2.10 showDialog
bool showDialog() const
Code Source
Retourne vrai quand la boite de dialogue est ouverte et faux si non.
Exemple de jeu
1. Introduction
Dans cette partie du document nous allons découvrir comment utiliser les fonctions de is::Engine 2.0 pour créer un
mini jeu. Notez que ceci est juste un petit tutoriel pour vous permettre de bien démarrer avec le moteur.
Nous allons créer un jeu d’arcade dans lequel on contrôle un Hélicopter qui doit éviter des obstacles et collecter des
objets bonus qui augmentent le temps du chronomètre et son score. Si le chronomètre du niveau atteint zéro (0), il perd
la partie.
97
Le jeu sera jouable sur Android et PC.
Vous pouvez accéder au projet ici.
2. Comment le jeu sera créé ?
2.1 Voici les éléments du moteur que le jeu utilisera
- Classe GameDisplay pour créer les scènes
- Classe MainObject et ces parents pour créer les objets de game play (Joueur, HUD, Bonus, …)
- Classe GameKeyData pour commander le joueur
- Classe GameDialog pour afficher le tutoriel
- GameLangague.h pour ajouter des phrases à traduire
- Certaines fonctions du moteur qui se trouvent dans GameFunction.h
- Classe Activity pour lancer les differents scènes et les faire interagir entre eux
2.2 Les objets qui seront utilisés dans le jeu
Un Menu principal qui contiendra ces objets :
- Un Texte pour le titre du jeu
- Deux (2) sprites qui serviront de Boutons : Un pour lancer le jeu et un autre pour quitter
- Deux (2) textes qui serviront de titre pour les Bouttons
Une Scène appelé GameLevel où se déroule le jeu et aura pour contenu :
- Un objet joueur qui servira d’Hélicoptère
- Un objet HUD
- Un sprite en forme de Croix pour quitter le Niveau
- Un sprite pour le background
- Des sons
- Un texte pour afficher le message de game over
- Un conteneur d’objet (std::vector) pour les Bonus
- Un conteneur d’objet (std::vector) pour les Obstacles
2.3 Les rôles des objets
Classe Activity
- Lancer les differents scènes
- Transition entre Menu Principal et Game Level et vis versa.
Classe MainMenu
- Naviguer dans le menu avec la souris (toucher sur Android) et clavier
- Utiliser les touches de validation pour choisir une option
- Quitter le menu grâce une boite de dialogue
Classe GameLevel
- Lancer la partie
- Recommencer le niveau quand le joueur perd
- Quitter le niveau quand l’utilisateur clic sur la croix (sprite)
Classe Player sera un Hélicoptère :
- Les touches HAUT, BAS, GAUCHE, DROITE serviront à déplacer l’objet
- La touche A pour accélérer
- La touche B pour la vitesse normale
- Animé le sprite
Classe Bonus
98
- Disparait quand le joueur le touche
- Augmenter le Score et le temps du joueur et joue un son quand il est detruit
Classe Obstacle
- Collision avec le joueur (retirer la santé)
Classe HUD
- Affiche le chronomètre du niveau
- Affiche le nombre de Bonus
- Affiche le score du joueur
- Affiche la santé du joueur
3. Intégration des phrases dans le jeu
3.1 Création des phrases dans GameLanguage.h
#include "../../isEngine/system/function/GameKeyName.h"
namespace is
{
/// Access to content that allows internationalization of the game
namespace lang
{
/// Represent the index of each language
enum GameLanguage
{
ENGLISH, ///< English language index
FRANCAIS, ///< French language index
};
// ------------------------ message box answer ------------------------
static std::string pad_answer_ok[] = {"OK", "OK"};
static std::string pad_answer_yes[] = {"YES", "OUI"};
static std::string pad_answer_no[] = {"NO", "NON"};
// ------------------------ intro ------------------------
static std::string pad_game_language[] = {"English", "French"};
// ------------------------ menu ------------------------
static std::string pad_main_menu[] = {"Main Menu", "Menu Principal"};
static std::string pad_new_game[] = {"Start Game", "Nouvelle Partie"};
static std::string pad_quit_game[] = {"Quit Game", "Quitter le Jeu"};
static std::string msg_quit_game[] = {"Quit game?", "Quitter le jeu?"};
// ------------------------ level dialog ------------------------
static std::string pad_dialog_skip[] = {"Skip", "Passer"};
#if defined(__ANDROID__)
static std::wstring dialog_player_move[] = {L"Press LEFT, RIGHT, UP or DOWN to move.\n"
"Press A to Accelerate and B to decelerate.",
L"Appuie sur GAUCHE, DROITE, HAUT, BAS pour te déplacer.\n"
"Appuie sur A pour Accélerer et B pour Ralentire."};
#else
static std::wstring dialog_player_move[] = {L"Press " + is::getKeyWName(is::GameConfig::KEY_LEFT) + L", " +
is::getKeyWName(is::GameConfig::KEY_RIGHT) + L", " +
is::getKeyWName(is::GameConfig::KEY_UP) + L" or " +
is::getKeyWName(is::GameConfig::KEY_DOWN) + L" to move.\n"
99
"Press " + is::getKeyWName(is::GameConfig::KEY_A) + L" to Accelerate and " +
is::getKeyWName(is::GameConfig::KEY_B) + L" to Decelerate.",
L"Appuie sur " + is::getKeyWName(is::GameConfig::KEY_LEFT) + L", " +
is::getKeyWName(is::GameConfig::KEY_RIGHT) + L", " +
is::getKeyWName(is::GameConfig::KEY_UP) + L" ou " +
is::getKeyWName(is::GameConfig::KEY_DOWN) + L" pour te déplacer.\n"
"Appuie sur " + is::getKeyWName(is::GameConfig::KEY_A) + L" pour Accélerer et " +
is::getKeyWName(is::GameConfig::KEY_B) + L" pour Ralentire."};
#endif
// ------------------------ game level ------------------------
static std::string msg_game_over[] = {"Your score : ", "Votre score : "};
static std::string msg_clic_restart[] = {"Click to restart", "Cliquer pour recommencer"};
}
}
Explication
Ce fichier permet de définir les phrases à traduire qui vont être utilisées dans le jeu. Une phrase à traduire est
représentée par un tableau de chaine (std::string ou std::wstring). La première case du tableau représente la première
langue, la case suivante la deuxième et ainsi de suite.
static std::wstring dialog_player_move
Code Source
Phrase qui sera utilisée plutard dans la Boite de dialogue pour montrer à l’utilisateur comment commander l’Hélico.
Sur Android on affiche comment bouger le joueur par rapport aux touches du Game Pad Virtuel et sur PC par rapport
aux touches du clavier (qui peuvent changer en fonction des paramètres définis dans GameConfig.h).
is::getKeyWName(is::GameConfig::KEY_LEFT)
Code Source
Permet d’obtenir le nom de la touche du clavier (sous forme de chaine std::wstring) grâce son code qui lui est associé.
Ceci permet de connaitre le nom de la touche du clavier associé à chaque action.
3.2 Assoiciation de la boite de dialogue avec la phrase du jeu
Le code ci-dessous est une partie de la déclaration de la classe GameDialog.
//…
enum DialogIndex
{
DIALOG_NONE = -1,
DIALOG_PLAYER_MOVE
};
// …
void linkArrayToEnum()
{
auto setMsg = [this](std::wstring txt)
{
m_strDialog = txt;
};
100
auto checkMsg =[this, &setMsg](std::wstring txt[])
{
if (m_msgIndex < m_msgIndexMax) setMsg(txt[m_msgIndex + m_scene->getGameSystem().m_gameLanguage]);
};
// each enum with its array of string
switch (m_dialogIndex)
{
case DIALOG_PLAYER_MOVE:
m_msgIndexMax = is::arraySize(is::lang::dialog_player_move);
checkMsg(is::lang::dialog_player_move);
break;
default:
break;
}
}
// …
Explication
L’enum DialogIndex et la fonction void linkArrayToEnum() sont les deux éléments de la classe GameDialog qui
nous permet d’afficher des phrases de GameLanguage.h avec la boite de dialogue.
DIALOG_PLAYER_MOVE
Code Source
Représente la phrase dialog_player_move de GameLanguage.h. Les éléments de l’enum DialogIndex permettent de
relier les phrases de GameLanguage.h et la classe GameDialog.
switch (m_dialogIndex)
{
case DIALOG_PLAYER_MOVE:
m_msgIndexMax = is::arraySize(is::lang::dialog_player_move);
checkMsg(is::lang::dialog_player_move);
break;
Code Source
Ces instructions permettent d’associer une phrase de GameLanguage.h avec la classe GameDialog. La procédure est la
même pour toute autre type de phrase mais n’oublier pas que pour chaque phrase (tableau de chaine) vous devez
définir son élément dans enum DialogIndex.
4. Création des classes du jeu
4.1 Classe Obstacle
4.1.1 Entête
#include "../../../isEngine/system/entity/MainObject.h"
#include "../../../isEngine/system/entity/parents/ScorePoint.h"
class Obstacle : public is::MainObject, public is::ScorePoint
{
public:
Obstacle(sf::Texture &tex, float x, float y);
void step(float const& DELTA_TIME);
};
101
Explication
Classe Obstacle est une classe qui hérite de MainObject (offre des fonctions pour gérer le déplacement et l’affichage de
l’objet) et ScorePoint une classe qui permet d’assigner des points bonus aux objets.
void step(float const& DELTA_TIME) permet de mettre à jour les instances de la classe Obstacle.
4.1.2 Implémentation
4.1.2.1 Obstacle
Obstacle::Obstacle(sf::Texture &tex, float x, float y):
MainObject(x, y),
ScorePoint(20)
{
// define collision mask
m_w = 32;
m_h = 32;
m_speed = -12.f;
// load texture
is::createSprite(tex, m_sprParent, sf::IntRect(0, 0, 32, 32), sf::Vector2f(m_x, m_y), sf::Vector2f(0.f, 0.f), false, false);
updateCollisionMask();
}
Explication
Constructeur de la classe qui prend en paramètre la texture et position de l’objet dans la scène.
ScorePoint(20) représente le score qui est attribué à l’objet. A l’intérieur du bloc il y a la définition de la taille du
masque de collision, la vitesse de déplacement de l’objet et la fonction qui permet de créer le sprite de l’objet.
4.1.2.2 step
void Obstacle::step(float const& DELTA_TIME)
{
m_x += ((m_speed * is::VALUE_CONVERSION) * DELTA_TIME);
updateCollisionMask();
updateSprite();
}
Explication
Cette méthode permet de déplacer l’objet vers la gauche en fonctions de sa vitesse, mettre à jour la position du masque
de collision et du sprite.
4.2 Classe Bonus
4.2.1 Entête
#include "../../../isEngine/system/entity/MainObject.h"
#include "../../../isEngine/system/entity/parents/Destructible.h"
#include "../../../isEngine/system/entity/parents/ScorePoint.h"
#include "../../../isEngine/system/entity/parents/Step.h"
#include "../../gamesystem_ext/GameSystemExtended.h"
class Bonus : public is::MainObject, public is::Destructible, public is::ScorePoint, public is::Step
{
public:
Bonus(sf::Texture &tex, float x, float y);
void step(float const &DELTA_TIME);
};
102
Explication
Classe fille de MainObject, elle hérite aussi de Destructible qui offre des fonctions pour gérer la destruction de ces
instances de façon explicite. ScorePoint pour attribuer un point à l’objet qui sera comptabilsé plus tard. Step permet de
gérer les différentes étapes de l’objet : collision avec le joueur et la destruction.
4.2.2 Implémentation
4.2.2.1 Bonus
Bonus::Bonus(sf::Texture &tex, float x, float y):
MainObject(x, y),
Destructible(),
ScorePoint(10),
Step(0)
{
m_w = 32;
m_h = 32;
m_speed = -15.f;
is::createSprite(tex, m_sprParent, sf::IntRect(0, 0, 32, 32), sf::Vector2f(m_x, m_y), sf::Vector2f(16.f, 16.f));
}
Explication
Constructeur qui prend la texture du sprite et la position de l’objet dans la scène.
A l’intérrieur, la taille du masque de collision a été définie avec la vitesse de déplacement de l’objet, suivis de la fonction
qui permet de créer le sprite de l’objet.
4.2.2.2 step
void Bonus::step(float const &DELTA_TIME)
{
m_x += ((m_speed * is::VALUE_CONVERSION) * DELTA_TIME);
if (m_step == 1) m_destroy = true;
updateSprite();
updateCollisionMask();
}
Explication
Cette méthode permet de déplacer l’objet et d’enclencher la destruction de l’objet quand son étape passe à 1. Elle met à
jour aussi les propriétés du sprite et celui du masque de collision.
4.3 Classe Player
4.3.1 Entête
#include "../../../isEngine/system/entity/MainObject.h"
#include "../../../isEngine/system/entity/parents/Health.h"
#include "../../../isEngine/system/entity/parents/HurtEffect.h"
#include "../../../isEngine/system/function/GameKeyData.h"
class Player : public is::MainObject, public is::Health, public is::HurtEffect
{
public:
Player(GameKeyData &gameKey);
void loadResources(sf::Texture &tex);
void step(float const &DELTA_TIME);
private:
GameKeyData &m_gameKey;
};
103
Explication
Classe fille de MainObjet, Health offre des méthodes qui permet de gérer la santé du joueur, HurtEffect permet de
faire un effet invincibilité (faire clignoté l’objet quand il est touché).
void loadResources(sf::Texture &tex)
Code Source
Permet d’attribuer des ressources exterieures (utilisé dans la scène) à l’objet.
GameKeyData &m_gameKey;
Code Source
Sert à utiliser l’objet qui permet de gérer les commandes du jeu.
4.3.2 Implémentation
4.3.2.1 Player
Player::Player(GameKeyData &gameKey):
MainObject(),
Health(3),
HurtEffect(m_sprParent),
m_gameKey(gameKey)
{
// define collision mask
m_w = 40;
m_h = 40;
m_isActive = true;
// initialize collision mask
updateCollisionMask();
}
Explication
Constructeur prend en paramètre l’instance de l’objet qui gère les commandes du jeu. Il permet aussi de définir le
nombre de santés du joueur et de choisir le sprite qui sera utilisé pour faire l’effet invincibilité quand le joueur est
touché par un obstacle.
A l’intérieur il y a la définition de la taille du masque de collision. La varaible m_isActive = true permet à l’utilisateur de
controller l’objet quand il n’a pas perdu.
4.3.2.2 loadResources
void Player::loadResources(sf::Texture &tex)
{
is::createSprite(tex, m_sprParent, sf::IntRect(0, 0, 48, 48), sf::Vector2f(m_x, m_y), sf::Vector2f(0.f, 0.f));
}
Explication
Permet d’utiliser la texture chargée dans la scène pour créer le sprite du joueur.
4.3.2.3 step
void Player::step(float const &DELTA_TIME)
{
if (m_isActive)
104
{
// allow accelerate / decelerate player
if (m_gameKey.m_keyBPressed) m_speed = 0.f;
else if (m_gameKey.m_keyAPressed) m_speed = 200.f;
// move
float const SPEED(2.f);
m_hsp = 0.f;
m_vsp = 0.f;
if (m_gameKey.m_keyRightPressed) m_hsp = SPEED;
else if (m_gameKey.m_keyLeftPressed) m_hsp = -SPEED;
else if (m_gameKey.m_keyDownPressed) m_vsp = SPEED;
else if (m_gameKey.m_keyUpPressed) m_vsp = -SPEED;
// animation
m_frame += (0.33f * is::VALUE_CONVERSION) * DELTA_TIME; // image speed
setFrame(0.f, 3.6f);
// update collision mask (position, size, ...)
updateCollisionMask();
// update object position
m_x += (m_hsp * is::VALUE_CONVERSION) * DELTA_TIME;
m_y += (m_vsp * is::VALUE_CONVERSION) * DELTA_TIME;
}
else m_frame = 0.f;
is::setFrame(m_sprParent, m_frame, 4, 48, 48, 48); // update sprite and animation
updateSprite();
hurtStep(DELTA_TIME);
}
Explication
Méthode dans laquelle on gère le comportement de l’objet. Ici quand la variable m_isActive est vrai alors l’utilisateur
peut faire accélérer l’hélico quand il appuie sur la touche A et le faire ralentir quand il appuie sur la touche B. Il peut
aussi déplacer l’objet avec les quatres (4) touches directionnelles. L’animation de l’Hélico (qui sera détaillé en
dessou) s’effectue aussi dans ce bloc.
Note : quand l’utilisateur accélère ou ralenti ça affecte aussi les autres objets de la scène (Obstacles, Bonus, Arrière
plan).
hurtStep(DELTA_TIME)
Code Source
Permet de faire l’animation invincibilité (faire clignoter le sprite).
Voici comment le sprite est animé :
Figure 1
Pour animer le sprite on utilise une texture (Figure 1) composée de plusieur sous image ayant les mêmes tailles.
Chaque sous image représente une valeur (en rouge) que peut prendre la variable m_frame. Ci-dessous les éléments
qui permettent de faire une animation :
105
is::setFrame(m_sprParent, m_frame, 4, 48, 48, 48)
Code Source
La fonction qui permet d’animer le sprite. Il prend en paramètre le sprite qui sera utilisé, la sous image qui sera
affichée, le nombre de sous image sur une ligne (ici qui est 4) et les 3 autres paramètres qui sont la taille des sous
images (ils se ressemblent mais ont des buts différents).
Note : La fonction découpe automatiquement l’image.
m_frame
Code Source
Permet définir la sous image du sprite qui sera affichée.
setFrame(0.f, 3.6f);
Code Source
Permet définir l’intervalle de m_frame c'est-à-dire les sous images à choisir.
4.4 Classe HUD
4.4.1 Entête
#include "../../../isEngine/system/entity/MainObject.h"
#include "../../../isEngine/system/function/GameTime.h"
#include "../../gamesystem_ext/GameSystemExtended.h"
#include "Player.h"
class HUD : public is::MainObject
{
public:
HUD(is::GameDisplay &scene, is::GameTime &gameTime, Player &player);
void loadResources(sf::Font const &fnt);
void step(float const &DELTA_TIME);
void draw(sf::RenderTexture &surface);
void setScore(int val);
private:
is::GameDisplay &m_scene;
is::GameTime &m_gameTime;
Player &m_player;
sf::Text m_txtHealth, m_txtBonus, m_txtLevelTime, m_txtScore;
};
Explication
Classe qui permet d’affiicher les informations de game play à l’écran.
is::GameDisplay &m_scene
Code Source
Permet d’avoir accès à la scène dans laquelle l’objet est utilisé pour pouvoir le positionner et utiliser les variables de
game play (score, nombre de bonus collectés).
is::GameTime &m_gameTime
Code Source
A pour but d’afficher le chronomètre du jeu.
106
Player &m_player
Code Source
Permet d’afficher la santé du joueur.
4.4.2 Implémentation
4.4.2.1 HUD
HUD::HUD(is::GameDisplay &scene, is::GameTime &gameTime, Player &player) :
m_scene(scene),
m_gameTime(gameTime),
m_player(player)
{}
Explication
Constructeur qui prend en paramètre la scène, l’objet qui gère le chronomètre du jeu et l’instance du joueur.
4.4.2.2 loadResources
void HUD::loadResources(sf::Font const &fnt)
{
int const TXT_SIZE(20);
is::createText(fnt, m_txtScore, " ", 0.f, 0.f, sf::Color(255, 255, 255, 255), sf::Color(0, 0, 0, 255), TXT_SIZE);
is::createText(fnt, m_txtLevelTime, " ", 0.f, 0.f, sf::Color(255, 255, 255, 255), sf::Color(0, 0, 0, 255), TXT_SIZE);
is::createText(fnt, m_txtHealth, " ", 0.f, 0.f, sf::Color(255, 0, 0, 255), sf::Color(0, 0, 0, 255), TXT_SIZE);
is::createText(fnt, m_txtBonus, " ", 0.f, 0.f, sf::Color(255, 255, 255, 255), sf::Color(0, 0, 0, 255), TXT_SIZE);
}
Explication
Permet d’utiliser la police de caractère chargée dans la scène pour créer les textes.
4.4.2.3 step
void HUD::step(float const &DELTA_TIME)
{
float const TXT_X_POS(-300.f), TXT_Y_POS(16.f);
m_txtScore.setString("Score : " + is::writeZero(m_scene.getGameSystem().m_currentScore, 4));
is::setSFMLObjX_Y(m_txtScore, m_scene.getViewX() + TXT_X_POS, (m_scene.getViewY() - m_scene.getViewH() / 2.f) +
TXT_Y_POS);
m_txtLevelTime.setString("Time : " + m_gameTime.getTimeString());
is::setSFMLObjX_Y(m_txtLevelTime, m_scene.getViewX() + TXT_X_POS + 150.f, (m_scene.getViewY() -
m_scene.getViewH() / 2.f) + TXT_Y_POS);
m_txtHealth.setString("Health : " + is::writeZero(m_player.getHealth()));
is::setSFMLObjX_Y(m_txtHealth, m_scene.getViewX() + TXT_X_POS + 305.f, (m_scene.getViewY() -
m_scene.getViewH() / 2.f) + TXT_Y_POS);
m_txtBonus.setString("Bonus : " + is::writeZero(m_scene.getGameSystem().m_currentBonus));
is::setSFMLObjX_Y(m_txtBonus, m_scene.getViewX() + TXT_X_POS + 415.f, (m_scene.getViewY() -
m_scene.getViewH() / 2.f) + TXT_Y_POS);
}
Explication
Cette méthode sert à positionner les textes sur l’écran et à mettre à jour leurs informations.
4.4.2.4 draw
void HUD::draw(sf::RenderTexture &surface)
{
surface.draw(m_txtScore);
107
surface.draw(m_txtLevelTime);
surface.draw(m_txtHealth);
surface.draw(m_txtBonus);
}
Explication
Affiche les différents textes à l’écran. Cette méthode est une surcharge !
4.5 Classe MainMenu
4.5.1 Entête
#include "../../../isEngine/system/function/GameFunction.h"
#include "../../../isEngine/system/display/GameDisplay.h"
class GameMenu : public is::GameDisplay
{
public:
GameMenu(sf::RenderWindow &window, sf::View &view, sf::RenderTexture &surface, GameSystemExtended
&gameSysExt);
void step();
void componentsController();
void draw();
bool loadResources();
private:
sf::Font m_fontTitle;
sf::Texture m_texPad, m_texScreenBG;
sf::Sprite m_sprPad1, m_sprPad2, m_sprScreenBG;
sf::Text m_txtGameTitle, m_txtStartGame, m_txtQuit;
bool m_isStart, m_closeApplication;
};
Explication
Déclaration de la classe qui permet de créer la scène du Menu Principal.
void componentsController()
Code Source
Méthode où seront gérés les boutons du menu principal.
4.5.2 Implémentation
4.5.2.1 MainMenu
GameMenu::GameMenu(sf::RenderWindow &window, sf::View &view, sf::RenderTexture &surface,
GameSystemExtended &gameSysExt):
GameDisplay(window, view, surface, gameSysExt, sf::Color::White),
m_isStart(true),
m_closeApplication(false)
{}
Explication
Constructeur de la classe, prend en paramètre la fenêtre, la vue, la surface et le gestionnaire du système de jeu. Il
permet aussi de définir la couleur de fond de la scène (ici qui est Blanc).
4.5.2.2 loadResources
bool GameMenu::loadResources()
{
108
if (!GameDisplay::loadParentResources()) return false;
m_gameSysExt.m_gameLanguage = is::lang::GameLanguage::ENGLISH; // set default language
// load textures
if (!m_texPad.loadFromFile(is::GameConfig::GUI_DIR + "main_menu_pad.png")) return false;
if (!m_texScreenBG.loadFromFile(is::GameConfig::GUI_DIR + "screen_background.png")) return false;
if (!m_fontTitle.loadFromFile(is::GameConfig::FONT_DIR + "space_ranger_3d_mp_pv.otf")) return false;
// game title
is::createWText(m_fontTitle, m_txtGameTitle, is::GameConfig::GAME_NAME, 65.f, 32.f, sf::Color(0, 0, 0), 64);
// create sprites
float const XPOS(225.f), YPOS(200.f), BTYSIZE(0.9f);
is::createSprite(m_texPad, m_sprPad1, sf::IntRect(0, 0, 192, 48), sf::Vector2f(XPOS, YPOS), sf::Vector2f(96.f, 24.f));
is::createSprite(m_texPad, m_sprPad2, sf::IntRect(0, 0, 192, 48), sf::Vector2f(XPOS, YPOS + 70.f), sf::Vector2f(96.f,
24.f));
is::createSprite(m_texPad, m_sprButtonSelect, sf::IntRect(192, 0, 192, 48), sf::Vector2f(XPOS, YPOS), sf::Vector2f(96.f,
24.f));
is::setSFMLObjScaleX_Y(m_sprPad1, 1.f, BTYSIZE);
is::setSFMLObjScaleX_Y(m_sprPad2, 1.f, BTYSIZE);
// sprite background
is::createSprite(m_texScreenBG, m_sprScreenBG, sf::IntRect(0, 0, 672, 512),sf::Vector2f(0.f, 0.f), sf::Vector2f(0.f , 0.f),
true);
// create text for main menu
float const TXT_Y_ON_BT(8.f);
int const _PAD_TXT_SIZE(22);
is::createText(m_fontSystem, m_txtStartGame, is::lang::pad_new_game[m_gameSysExt.m_gameLanguage],
is::getSFMLObjX(m_sprPad1), is::getSFMLObjY(m_sprPad1) - TXT_Y_ON_BT, sf::Color::Blue, true,
_PAD_TXT_SIZE);
is::createText(m_fontSystem, m_txtQuit, is::lang::pad_quit_game[m_gameSysExt.m_gameLanguage],
is::getSFMLObjX(m_sprPad2), is::getSFMLObjY(m_sprPad2) - TXT_Y_ON_BT, true, _PAD_TXT_SIZE);
return true;
}
Explication
Cette méthode charge les ressources qui seront utilisés dans le menu et positionne les objets.
m_gameSysExt.m_gameLanguage = is::lang::GameLanguage::ENGLISH;
Code Source
Permet de définir la langue par défaut du jeu. Si vous changez la valeur en is::lang::GameLanguage::FRENCH la langue
française sera choisie.
is::lang::pad_new_game[m_gameSysExt.m_gameLanguage]
Code Source
- is::lang::pad_new_game : permet d’utiliser le tableau qui se trouve dans GameLanguage.h.
- [m_gameSysExt.m_gameLanguage] : permet de chosir la phrase qui correspond à la langue.
4.5.2.3 componentsController
void GameMenu::componentsController()
{
const short OP_START_GAME(0), OP_QUIT(1);
109
// allow to know is mouse is in collision with sprite
bool mouseInCollisonPad(false);
// allows activated use of buttons
if (!m_gameSysExt.keyIsPressed(is::GameConfig::KEY_UP) &&
!m_gameSysExt.keyIsPressed(is::GameConfig::KEY_DOWN) &&
!m_gameSysExt.isPressed())
m_gameSysExt.m_keyIsPressed = false;
// m_isClose allow to deactivate scene object
if (!m_isClose)
{
if (mouseCollision(m_sprPad1) || mouseCollision(m_sprPad2)) mouseInCollisonPad = true;
// change option with mouse (touch on Android)
if (mouseCollision(m_sprPad1) && m_optionIndex != OP_START_GAME) setOptionIndex(OP_START_GAME, true,
1.4f);
if (mouseCollision(m_sprPad2) && m_optionIndex != OP_QUIT) setOptionIndex(OP_QUIT, true, 1.4f);
// avoid the long pressing button effect
if (!mouseInCollisonPad && m_gameSysExt.isPressed(is::GameSystem::ValidationButton::MOUSE))
m_gameSysExt.m_keyIsPressed = true;
// change option with keyboard (only for PC)
if (!m_gameSysExt.m_keyIsPressed && !mouseInCollisonPad)
{
if (m_gameSysExt.keyIsPressed(is::GameConfig::KEY_UP)) setOptionIndex(-1, false, 1.4f);
else if (m_gameSysExt.keyIsPressed(is::GameConfig::KEY_DOWN)) setOptionIndex(1, false, 1.4f);
if (m_optionIndex < OP_START_GAME) m_optionIndex = OP_QUIT;
if (m_optionIndex > OP_QUIT) m_optionIndex = OP_START_GAME;
}
// launch a dialog box which allow to quit the game
auto lauchDialogBox = [this]()
{
showMessageBox(is::lang::msg_quit_game[m_gameSysExt.m_gameLanguage]);
m_closeApplication = true;
m_keyBackPressed = false;
};
// validate menu option
if ((m_gameSysExt.isPressed(is::GameSystem::ValidationButton::KEYBOARD) ||
(m_gameSysExt.isPressed(is::GameSystem::ValidationButton::MOUSE) && mouseInCollisonPad)) &&
(m_waitTime == 0 && !m_gameSysExt.m_keyIsPressed))
{
auto playSelectSnd = [this]()
{
m_gameSysExt.playSound(m_sndSelectOption);
m_sprButtonSelectScale = 1.4f;
m_gameSysExt.useVibrate(m_vibrateTimeDuration);
};
switch (m_optionIndex)
{
case OP_START_GAME:
playSelectSnd();
m_gameSysExt.m_launchOption = is::DisplayOption::GAME_LEVEL;
m_isClose = true;
break;
case OP_QUIT: lauchDialogBox(); break;
}
m_keyBackPressed = false;
110
}
// Quit game
if (m_keyBackPressed) lauchDialogBox();
// change the color of the texts according to the chosen option
setTextAnimation(m_txtStartGame, m_sprPad1, OP_START_GAME);
setTextAnimation(m_txtQuit, m_sprPad2, OP_QUIT);
// PAD animation
is::scaleAnimation(DELTA_TIME, m_sprButtonSelectScale, m_sprButtonSelect, is::getSFMLObjXScale(m_sprPad1));
}
}
Explication
Cette méthode est une sous fonction de step(). Elle permet d’utiliser les touches du jeu et la souris (devient la fonction
touchée sur Android) pour naviguer dans le menu et choisir une option. Elle permet aussi d’animer les objets du menu
principal quand on éffectue une action (survole souris, clic, appuie d’une touche).
setOptionIndex(-1, false, 1.4f);
Code Source
Anime le texte et le sprite et joue un son quand on change une option.
m_gameSysExt.m_launchOption = is::DisplayOption::GAME_LEVEL
Code Source
Informe le moteur que la prochaine scène à lancer sera celui du Niveau.
4.5.2.4 step
void GameMenu::step()
{
DELTA_TIME = getDeltaTime();
updateTimeWait(DELTA_TIME);
// even loop
while (m_window.pollEvent(m_event))
{
controlEventFocusClosing();
if (m_event.type == sf::Event::KeyReleased)
{
if (m_event.key.code == is::GameConfig::KEY_CANCEL) m_keyBackPressed = true;
}
}
// starting mechanism
if (m_isStart)
{
// window has focus
if (m_windowIsActive)
{
if (!m_showMsg)
{
componentController();
}
// MESSAGE BOX
else
111
{
updateMsgBox(DELTA_TIME);
// when user closes message box in update function execute this instruction
// "m_waitTime" allow to disable clicks on objects during a moment when user closes message box
if (!m_showMsg)
{
if (m_closeApplication) // quit game
{
if (m_msgAnswer == MsgAnswer::YES)
{
m_window.close();
m_isRunning = false;
}
else
{
m_waitTime = 20;
m_closeApplication = false;
}
}
}
}
}
}
if (m_isClose)
{
m_isStart = false;
m_isRunning = false;
}
}
Explication
Cette méthode gère la partie évenement associée à la scène et de la boite de dialogue du moteur de jeu (non pas celui
du tutoriel mais celle qui affiche un bouton OUI - NON), ainsi que la fermeture de l’application.
m_isRunning = false;
Code Source
Permet de stopper l’éxécution de la scène afin de pouvoir la quitter.
4.5.2.5 draw
void GameMenu::draw()
{
const short OP_START_GAME(0), OP_QUIT(1);
// draw background
m_surface.draw(m_sprScreenBG);
// draw game title
m_surface.draw(m_txtGameTitle);
// draw button
if (m_optionIndex != OP_START_GAME) m_surface.draw(m_sprPad1);
if (m_optionIndex != OP_QUIT) m_surface.draw(m_sprPad2);
m_surface.draw(m_sprButtonSelect);
m_surface.draw(m_txtStartGame);
m_surface.draw(m_txtQuit);
112
// message box
drawMsgBox();
}
Explication
Affiche les composants du Menu Principal.
4.6 Classe GameLevel
4.6.1 Entête
#include <memory>
#include "../../../isEngine/system/display/GameDisplay.h"
#include "../../../isEngine/system/function/GameKeyData.h"
#include "../../objects/gamelevel/Player.h"
#include "../../objects/gamelevel/Obstacle.h"
#include "../../objects/gamelevel/HUD.h"
#include "../../objects/gamelevel/Bonus.h"
#include "../../objects/widgets/GameDialog.h"
#include "../../language/GameLanguage.h"
class GameLevel : public is::GameDisplay
{
public:
GameLevel(sf::RenderWindow &window, sf::View &view, sf::RenderTexture &surface, GameSystemExtended
&gameSysExt);
void step();
void draw();
bool loadResources();
private:
void gamePlay();
void updateObjObstacleList();
void updateObjBonusList();
void playerLose();
void updateObjPlayer();
void updateBackground();
private:
std::vector<std::shared_ptr<Obstacle>> m_obstacleList;
std::vector<std::shared_ptr<Bonus>> m_bonusList;
sf::Texture m_texButtonClose, m_texPlayer, m_texObstacle, m_texBonus, m_texDialog, m_texJoystick, m_texLevelBg;
sf::Sprite m_sprLevelBg, m_sprButtonClose;
sf::Text m_txtGameInfo;
sf::SoundBuffer m_sbHurt, m_sbLose, m_sbHaveBonus;
sf::Sound m_sndHurt, m_sndLose, m_sndHaveBonus;
sf::Music m_mscLevel;
GameKeyData m_gameKey;
is::GameTime m_gameTime;
GameDialog m_gameDialog;
Player m_player;
HUD m_gameHud;
int m_timeCreateOstacle, m_timeCreateBonus;
};
Explication
Déclaration de la classe qui représente le niveau.
std::vector<std::shared_ptr<Obstacle>> m_obstacleList
113
std::vector<std::shared_ptr<Bonus>> m_bonusList
Code Source
Conteneur des objets Bonus et Obstacles.
GameKeyData m_gameKey
Code Source
Objet qui permet de gérer les commandes du jeu afin de controller le joueur : touche du clavier, souris et Game Pad
Virtuel.
is::GameTime m_gameTime;
Code Source
Chronomètre du niveau.
sf::Text m_txtGameInfo
Code Source
Affiche un message et le score du joueur quand il pert la partie.
int m_timeCreateOstacle, m_timeCreateBonus
Code Source
Variable de type compteur (en milliseconde) pour générer des objets aléatoire dans la scène.
4.6.2 Implémentation
4.6.2.1 GameLevel
GameLevel::GameLevel(sf::RenderWindow &window, sf::View &view, sf::RenderTexture &surface,
GameSystemExtended &gameSysExt):
GameDisplay(window, view, surface, gameSysExt, sf::Color::White),
m_gameKey(this),
m_gameDialog(this),
m_player(m_gameKey),
m_gameHud(*this, m_gameTime, m_player),
m_timeCreateOstacle(59 * is::choose(2, 3, 5)),
m_timeCreateBonus(59 * is::choose(2, 4, 9))
{}
Explication
On définie un temps par défaut pour les compteurs qui permettent de générer des objets de façons aléatoire dans le
niveau.
4.6.2.2 loadResources
bool GameLevel::loadResources()
{
if (!GameDisplay::loadParentResources()) return false;
// load buffers
if (!m_sbHurt.loadFromFile(is::GameConfig::SFX_DIR + "hurt.ogg")) return false;
if (!m_sbLose.loadFromFile(is::GameConfig::SFX_DIR + "lose.ogg")) return false;
if (!m_sbHaveBonus.loadFromFile(is::GameConfig::SFX_DIR + "have_bonus.ogg")) return false;
// sound
114
m_sndHurt.setBuffer(m_sbHurt);
m_sndLose.setBuffer(m_sbLose);
m_sndHaveBonus.setBuffer(m_sbHaveBonus);
// GUI resources
if (!m_texButtonClose.loadFromFile(is::GameConfig::GUI_DIR + "button_close.png")) return false;
if (!m_texDialog.loadFromFile(is::GameConfig::GUI_DIR + "dialog_box.png")) return false;
if (!m_texJoystick.loadFromFile(is::GameConfig::GUI_DIR + "game_pad.png")) return false;
m_gameKey.loadResources(m_texJoystick);
m_gameKey.step(0.f); // initialize sprite position
// sprites
if (!m_texPlayer.loadFromFile(is::GameConfig::SPRITES_DIR + "player.png")) return false;
if (!m_texBonus.loadFromFile(is::GameConfig::SPRITES_DIR + "bonus.png")) return false;
if (!m_texObstacle.loadFromFile(is::GameConfig::SPRITES_DIR + "obstacle.png")) return false;
// background
if (!m_texLevelBg.loadFromFile(is::GameConfig::TILES_DIR + "level_bg.png")) return false;
// CREATION OF THE LEVEL
// place the player
m_player.loadResources(m_texPlayer);
m_player.setPosition(32.f, 220.f);
// set time
m_gameTime.setTimeValue(0, 29, 59);
// create game over text
is::createText(m_fontMsg, m_txtGameInfo, "", 240.f, 200.f, false, 24);
// create close button
is::createSprite(m_texButtonClose, m_sprButtonClose, sf::IntRect(0, 0, 32, 32), sf::Vector2f(600.f, 16.f),
sf::Vector2f(0.f, 0.f), true);
// build background
// We enlarge the size of the background to make it repeat in game endlessly
is::createSprite(m_texLevelBg, m_sprLevelBg, sf::IntRect(0, 0, m_texLevelBg.getSize().x * 2.5, 480), sf::Vector2f(0.f,
0.f), sf::Vector2f(0.f, 0.f), true);
// load HUD resources
m_gameHud.setPosition(m_viewX, m_viewY);
m_gameHud.loadResources(m_fontSystem);
// load Dialog Box resources
m_gameDialog.loadResources(m_texDialog, m_fontSystem);
m_gameDialog.setDialog(GameDialog::DialogIndex::DIALOG_PLAYER_MOVE);
// load level music
m_mscLevel.openFromFile(is::GameConfig::MUSIC_DIR + "world_1_music.ogg");
m_mscLevel.setLoop(true);
m_mscLevel.play();
return true;
}
Explication
Méthode pour charger les ressources du jeu (musique, sons, sprite, …), définir les paramètres de création de certains
objets et de positionner les objets dans la scène.
m_gameTime.setTimeValue(0, 29, 59)
115
Code Source
Définie le temps du chronomètre.
is::createSprite(m_texLevelBg, m_sprLevelBg, sf::IntRect(0, 0, m_texLevelBg.getSize().x * 2.5, 480),
sf::Vector2f(0.f, 0.f), sf::Vector2f(0.f, 0.f), true)
Code Source
Permet de créer l’arrière plan du niveau en répétant sa taille sur la longueur 2.5 fois. Ceci permet de faire défiler le
l’arriere plan de façon infinie sur l’axe des x.
m_gameDialog.setDialog(GameDialog::DialogIndex::DIALOG_PLAYER_MOVE)
Code Source
Permet d’afficher la boite de dialogue avec le message qui montre comment commander le joueur.
4.6.2.3 updateObjPlayer
void GameLevel::updateObjPlayer()
{
m_player.step(DELTA_TIME);
}
Explication
Méthode qui met à jour le joueur.
4.6.2.4 playerLose
void GameLevel::playerLose()
{
m_mscLevel.stop();
m_gameSysExt.playSound(m_sndLose);
m_txtGameInfo.setString(is::lang::msg_game_over[m_gameSysExt.m_gameLanguage] +
is::numToStr(m_gameSysExt.m_currentScore) + "\n" +
is::lang::msg_clic_restart[m_gameSysExt.m_gameLanguage]);
m_player.setIsActive(false);
}
Explication
Cette méthode permet de stopper la partie quand le joueur n’a plus de santé. Elle stoppe la musique du jeu, définie le
texte de game over avec le score du joueur qui sera affiché et désactive le joueur (ce qui veut dire qu’il a perdu).
4.6.2.5 updateObjObstacleList
void GameLevel::updateObjObstacleList()
{
WITH(m_obstacleList.size())
{
if (is::instanceExist(m_obstacleList[_I]))
{
// apply player acceleration on the object
m_obstacleList[_I]->moveX(-m_player.getSpeed() * DELTA_TIME);
// If the player touches the obstacle, his health is removed. if he is no longer healthy then game over
if (m_player.placeMetting(0, 0, m_obstacleList[_I]))
{
if (m_player.getHealth() > 1)
{
m_gameSysExt.playSound(m_sndHurt);
116
m_player.setIsHurt(30.f); // make blink
m_player.addHealth(-1);
m_obstacleList[_I].reset();
break;
}
else playerLose();
}
m_obstacleList[_I]->step(DELTA_TIME); // update object
// We destroy the object when it leaves to the left of the view
if (m_obstacleList[_I]->getX() < -32.f)
{
m_gameSysExt.m_currentScore += m_obstacleList[_I]->getScorePoint(); // add score point
m_obstacleList[_I].reset();
}
}
}
}
Explication
Méthode qui met à jour les Obstacles. A l’interieur de la boucle WITH on vérifie si le joueur est en collision avec l’objet,
si oui on detruit l’obstacle et on retire une santé, mais s’il n’a plus de santé alors la partie est terminée.
if (m_obstacleList[_I]->getX() < -32.f)
Code Source
Permet de savoir si l’objet est sorti du coté gauche de la fenêtre. Si oui on le détruit pour libérer l’espace mémoire et on
ajoute des points au joueur.
4.6.2.6 updateObjBonusList
void GameLevel::updateObjBonusList()
{
WITH(m_bonusList.size())
{
if (is::instanceExist(m_bonusList[_I]))
{
// apply player acceleration on the object
m_bonusList[_I]->moveX(-m_player.getSpeed() * DELTA_TIME);
if (m_player.placeMetting(0, 0, m_bonusList[_I]) && m_bonusList[_I]->getStep() == 0)
{
m_gameSysExt.m_currentBonus++;
m_gameTime.addTimeValue(0, 15, 0); // add 10 second
m_gameSysExt.m_currentScore += m_bonusList[_I]->getScorePoint(); // add score point
m_gameSysExt.playSound(m_sndHaveBonus);
m_bonusList[_I]->addStep();
}
m_bonusList[_I]->step(DELTA_TIME); // update object
// destruction
if (m_bonusList[_I]->isDestroyed() || m_bonusList[_I]->getX() < -32.f) m_bonusList[_I].reset();
}
}
}
Explication
Méthode qui met à jour les Bonus. A l’interieur de la boucle WITH on vérifie si le joueur est en collision avec l’objet si
oui on ajoute un point et on augmente le temps du niveau.
117
Après on vérifie si le Bonus est sorti du coté gauche de la fenêtre, si oui on le détruit pour libérer l’espace mémoire.
m_bonusList[_I]->getStep() == 0
Code Source
Permet d’exécuter des actions lors de la collision une seule fois et de pouvoir supprimer le Bonus plus tard.
4.6.2.7 updateBackground
void GameLevel::updateBackground()
{
// Allows you to repeat the background endlessly
if (is::getSFMLObjX(m_sprLevelBg) < -static_cast<float>(m_texLevelBg.getSize().x)) is::setSFMLObjX(m_sprLevelBg,
0.f);
is::moveSFMLObjX(m_sprLevelBg, -(1.f * is::VALUE_CONVERSION + m_player.getSpeed()) * DELTA_TIME);
}
Explication
Cette méthode met à jour le background en simulant une animation de défilement infinie.
4.6.2.8 gamePlay
void GameLevel::gamePlay()
{
// GAME CONTROLLER
if (!m_gameSysExt.isPressed()) m_gameSysExt.m_keyIsPressed = false;
m_gameKey.step(DELTA_TIME);
// LEVEL CHRONOMETER
if (m_gameTime.getTimeValue() != 0) m_gameTime.step(DELTA_TIME, is::VALUE_CONVERSION, is::VALUE_TIME);
else playerLose();
// We create a second counter which creates objects randomly
m_timeCreateOstacle -= is::getMSecond(DELTA_TIME);
if (m_timeCreateOstacle == 0)
{
m_obstacleList.push_back(std::shared_ptr<Obstacle>(new Obstacle(m_texObstacle, m_viewW + 10.f,
m_player.getY())));
m_timeCreateOstacle = 59 * is::choose(3, 10, 3, 5);
}
m_timeCreateBonus -= is::getMSecond(DELTA_TIME);
if (m_timeCreateBonus == 0)
{
m_bonusList.push_back(std::shared_ptr<Bonus>(new Bonus(m_texBonus, m_viewW + 10.f, m_player.getY())));
m_timeCreateBonus = 59 * is::choose(3, 10, 20, 25);
}
// OBSTACLE
updateObjObstacleList();
// BONUS
updateObjBonusList();
// PLAYER
updateObjPlayer();
// HUD
m_gameHud.step(DELTA_TIME);
// BACKGROUND
118
updateBackground();
}
Explication
Sous fonction de step(), elle gère le chronomètre du niveau, les commandes du jeu, les compteurs qui génerent les
objets Bonus et Obstacle et d’appler les fonctions qui mettent à jour les objets du game play.
4.6.2.9 step
void GameLevel::step()
{
DELTA_TIME = getDeltaTime();
updateTimeWait(DELTA_TIME);
// even loop
while (m_window.pollEvent(m_event))
{
controlEventFocusClosing();
if (m_event.type == sf::Event::KeyReleased)
{
if (m_event.key.code == is::GameConfig::KEY_CANCEL) m_keyBackPressed = true;
}
}
// if the window is activated launch the game
if (m_windowIsActive)
{
// If the player loses and clicks on the screen then restart the level
if (m_gameSysExt.isPressed() && !m_player.getIsActive())
{
m_gameSysExt.playSound(m_sndSelectOption);
m_gameSysExt.m_launchOption = is::DisplayOption::RESTART_LEVEL;
m_isRunning = false;
}
// if player clicks on close button sprite then quit game
if (mouseCollision(m_sprButtonClose) && m_gameSysExt.isPressed())
{
m_mscLevel.stop();
m_gameSysExt.playSound(m_sndSelectOption);
m_gameSysExt.m_launchOption = is::DisplayOption::MAIN_MENU;
m_isRunning = false;
}
if (!m_gameDialog.showDialog())
{
if (m_player.getIsActive()) gamePlay();
}
else
{
if (!mouseCollision(m_gameDialog.getSprite()) && m_gameSysExt.isPressed()) m_gameSysExt.m_keyIsPressed =
true;
m_gameDialog.setPosition(m_viewX, m_viewY + 32.f);
}
m_gameDialog.step(DELTA_TIME);
}
}
Explication
Cette méthode gère la partie évenement associé à la scène, la boite de dialogue pour le tutoriel et les options qui
permettent de recommencer un niveau ou de le quitter pour une autre.
119
m_gameSysExt.m_launchOption = is::DisplayOption::MAIN_MENU
m_gameSysExt.m_launchOption = is::DisplayOption::RESTART_LEVEL;
Code Source
L’action qui sera effectué sur une scène.
4.6.2.10 draw
void GameLevel::draw()
{
// draw background
m_surface.draw(m_sprLevelBg);
// draw bonus
WITH(m_bonusList.size())
{
if (is::instanceExist(m_bonusList[_I]))
{
if (m_bonusList[_I]->inViewRec(*this)) m_bonusList[_I]->draw(m_surface);
}
}
// draw blocks
WITH(m_obstacleList.size())
{
if (is::instanceExist(m_obstacleList[_I]))
{
if (m_obstacleList[_I]->inViewRec(*this)) m_obstacleList[_I]->draw(m_surface);
}
}
m_player.draw(m_surface);
m_gameHud.draw(m_surface);
// draw close button
m_surface.draw(m_sprButtonClose);
if (!m_player.getIsActive()) m_surface.draw(m_txtGameInfo);
// draw dialog box
m_gameDialog.draw(m_surface);
}
Explication
Affiche les objets de la scène.
5. Intégration et utilisation des scènes dans Activity
#include <memory>
#include "SwooshFiles.h"
#include "../scenes/GameMenu/GameMenu.h"
#include "../scenes/GameLevel/GameLevel.h"
using namespace swoosh::intent;
class GameActivity : public Activity
{
private:
std::shared_ptr<is::GameDisplay> m_gameScene;
public:
GameActivity(ActivityController& controller, GameSystemExtended &gameSysExt) :
120
Activity(&controller)
{
m_gameScene = nullptr;
switch (gameSysExt.m_launchOption)
{
case is::DisplayOption::MAIN_MENU:
m_gameScene = std::shared_ptr<is::GameDisplay>(new GameMenu(controller.getWindow(),
getView(),
*(this->controller->getSurface()),
gameSysExt));
break;
case is::DisplayOption::GAME_LEVEL:
m_gameScene = std::shared_ptr<is::GameDisplay>(new GameLevel(controller.getWindow(),
getView(),
*(this->controller->getSurface()),
gameSysExt));
break;
default:
is::showLog("Error : Scene not found !");
std::terminate();
break;
}
if (!m_gameScene->loadResources())
{
is::showLog("Error in loadResources function !");
std::terminate();
}
this->setBGColor(m_gameScene->getBgColor());
}
virtual void onUpdate(double elapsed)
{
if (m_gameScene->isRunning()) m_gameScene->step();
else
{
switch (m_gameScene->getGameSystem().m_launchOption)
{
case is::DisplayOption::MAIN_MENU:
{
using transition = segue<VerticalSlice, sec<2>>;
using action = transition::to<GameActivity>;
getController().replace<action>(m_gameScene->getGameSystem());
}
break;
case is::DisplayOption::GAME_LEVEL:
{
using transition = segue<VerticalSlice, sec<2>>;
using action = transition::to<GameActivity>;
getController().replace<action>(m_gameScene->getGameSystem());
}
break;
case is::DisplayOption::RESTART_LEVEL : // restart level (when player loses)
m_gameScene->getGameSystem().initData(false);
m_gameScene->getGameSystem().m_launchOption = is::DisplayOption::GAME_LEVEL;
using transition = segue<BlackWashFade>;
using action = transition::to<GameActivity>;
getController().replace<action>(m_gameScene->getGameSystem());
121
break;
default:
is::showLog("Error : Scene not found !");
std::terminate();
break;
}
}
}
virtual void onDraw(sf::RenderTexture& surface)
{
m_gameScene->drawScreen();
}
virtual void onStart() {}
virtual void onLeave(){}
virtual void onExit(){}
virtual void onEnter(){}
virtual void onResume(){}
virtual void onEnd() {}
};
Explication
#include "../scenes/GameMenu/GameMenu.h"
#include "../scenes/GameLevel/GameLevel.h"
Code Source
Permet d’inclure les deux scènes afin de les utilisées dans la classe Activity.
std::shared_ptr<is::GameDisplay> m_gameScene;
Code Source
Représente l’instance qui stockera la scène à exécuter. Attention c’est une variable qui s’adapte à la scène !
case is::DisplayOption::MAIN_MENU:
m_gameScene = std::shared_ptr<is::GameDisplay>(new GameMenu(controller.getWindow(),
getView(),
*(this->controller->getSurface()),
gameSysExt));
Code Source
Permet de lancer la scène du Menu Principal. Si switch (m_gameScene->getGameSystem().m_launchOption) est
équivalent à case is::DisplayOption::MAIN_MENU.
if (m_gameScene->isRunning()) m_gameScene->step();
Code Source
Lance la partie step() (mise à jour des contenus) d’une scène.
using transition = segue<VerticalSlice, sec<2>>;
using action = transition::to<GameActivity>;
getController().replace<action>(m_gameScene->getGameSystem());
Code Source
Ces instructions permettent de passer d’une scène à une autre en faisant un effet transition (Swoosh).
122
N’oublier pas qu’on arrive à déterminer la scène qui sera changée par une autre grâce à : switch (m_gameScene-
>getGameSystem().m_launchOption) et l’instruction case is::DisplayOption::nom_de_la_scene:
Cliquer ici pour avoir plus d’information sur l’utilisation des fonctions de la bibliothèque SWOOSH.
m_gameScene->drawScreen();
Code Source
Lance la partie draw() (affichage des contenus) d’une scène.
6. Amélioration
Il y a encore plein de fonctionnalités qu’on peut apporter à ce mini jeu, en voici quelques un :
- Eviter que le joueur sorte de l’écran quand on le déplace
- Une interface dans le Menu Princiapal qui permet de changer la langue du jeu
- Une interface dans le Menu Princiapal qui permet d’activer / désactiver le son du jeu
- Augmenter la vitesse des Obstacles et Bonus au fur et à mesure que le score augmente
- Ajouter un bouton pour mettre le jeu en pause
- Etc...
Maintenant c'est à vous de jouer !
